org.springdoc.webmvc.api

Class MultipleOpenApiResource

java.lang.Object

org.springdoc.webmvc.api.MultipleOpenApiResource

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

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

The type Multiple open api resource.

Author:

bnasslahsen

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> actuatorProvider, SpringDocConfigProperties springDocConfigProperties, Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider, Optional<RouterFunctionProvider> routerFunctionProvider, Optional<RepositoryRestResourceProvider> repositoryRestResourceProvider) Instantiates a new Multiple open api resource.

Method Summary

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

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> actuatorProvider,
                               SpringDocConfigProperties springDocConfigProperties,
                               Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider,
                               Optional<RouterFunctionProvider> routerFunctionProvider,
                               Optional<RepositoryRestResourceProvider> repositoryRestResourceProvider)

Instantiates a new Multiple open api resource.

Parameters:

groupedOpenApis - the grouped open apis

defaultOpenAPIBuilder - the default open api builder

requestBuilder - the request builder

responseBuilder - the response builder

operationParser - the operation parser

requestMappingHandlerMapping - the request mapping handler mapping

actuatorProvider - the actuator provider

springDocConfigProperties - the spring doc config properties

springSecurityOAuth2Provider - the spring security o auth 2 provider

routerFunctionProvider - the router function provider

repositoryRestResourceProvider - the repository rest resource provider

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

Openapi json string.

Parameters:

request - the request

apiDocsUrl - the api docs url

group - the group

Returns:

the string

Throws:

com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

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

Openapi yaml string.

Parameters:

request - the request

apiDocsUrl - the api docs url

group - the group

Returns:

the string

Throws:

com.fasterxml.jackson.core.JsonProcessingException - the json processing exception