Package tech.jhipster.config.apidoc

Class JHipsterOpenApiEndpoint

java.lang.Object

tech.jhipster.config.apidoc.JHipsterOpenApiEndpoint

@WebEndpoint(id="jhiopenapigroups")
public class JHipsterOpenApiEndpoint
extends Object

JHipsterOpenApiEndpoint class.

Constructor Summary

Constructors

Constructor	Description
JHipsterOpenApiEndpoint(org.springdoc.core.properties.SpringDocConfigProperties springDocConfigProperties, String appName)	Constructor for JHipsterOpenApiEndpoint.

Method Summary

Modifier and Type	Method	Description
List<Map<String,String>>	allOpenApi()	GET /management/jhiopenapigroups

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JHipsterOpenApiEndpoint

public JHipsterOpenApiEndpoint(org.springdoc.core.properties.SpringDocConfigProperties springDocConfigProperties,
 String appName)

Constructor for JHipsterOpenApiEndpoint.

Parameters:

springDocConfigProperties - a SpringDocConfigProperties object.

Method Details

allOpenApi

@ReadOperation
public List<Map<String,String>> allOpenApi()

GET /management/jhiopenapigroups

Give openApi displayed on OpenApi page

Returns:

a Map with a String defining a category of openApi as Key and another Map containing openApi related to this category as Value