org.springdoc.api

Class MultipleOpenApiResource

java.lang.Object

org.springdoc.api.MultipleOpenApiResource

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

@RestController
public class MultipleOpenApiResource
extends Object
implements org.springframework.beans.factory.InitializingBean

Constructor Summary

Constructors

Constructor and Description

MultipleOpenApiResource(List<GroupedOpenApi> groupedOpenApis, org.springframework.beans.factory.ObjectFactory<OpenAPIBuilder> defaultOpenAPIBuilder, AbstractRequestBuilder requestBuilder, GenericResponseBuilder responseBuilder, OperationBuilder operationParser, org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping requestMappingHandlerMapping, Optional<ActuatorProvider> servletContextProvider, SpringDocConfigProperties springDocConfigProperties)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
String	openapiJson(javax.servlet.http.HttpServletRequest request, String apiDocsUrl, String group)
String	openapiYaml(javax.servlet.http.HttpServletRequest request, String apiDocsUrl, String group)

Methods inherited from class java.lang.Object

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

Constructor Detail

MultipleOpenApiResource

public MultipleOpenApiResource(List<GroupedOpenApi> groupedOpenApis,
                               org.springframework.beans.factory.ObjectFactory<OpenAPIBuilder> defaultOpenAPIBuilder,
                               AbstractRequestBuilder requestBuilder,
                               GenericResponseBuilder responseBuilder,
                               OperationBuilder operationParser,
                               org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping requestMappingHandlerMapping,
                               Optional<ActuatorProvider> servletContextProvider,
                               SpringDocConfigProperties springDocConfigProperties)

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

openapiJson

@GetMapping(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}/{group}",
            produces="application/json")
public String openapiJson(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                     @Value(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}")
                                                                                                                                                                                     String apiDocsUrl,
                                                                                                                                                                                     @PathVariable
                                                                                                                                                                                     String group)
                                                                                                                                                                              throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

openapiYaml

@GetMapping(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}.yaml/{group}",
            produces="application/vnd.oai.openapi")
public String openapiYaml(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                     @Value(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}.yaml")
                                                                                                                                                                                                     String apiDocsUrl,
                                                                                                                                                                                                     @PathVariable
                                                                                                                                                                                                     String group)
                                                                                                                                                                                              throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException