Class MultipleOpenApiWebFluxResource

  • All Implemented Interfaces:
    org.springframework.beans.factory.InitializingBean

    @RestController
    public class MultipleOpenApiWebFluxResource
    extends MultipleOpenApiResource
    The type Multiple open api resource.
    Author:
    bnasslahsen
    • Constructor Detail

      • MultipleOpenApiWebFluxResource

        public MultipleOpenApiWebFluxResource​(List<GroupedOpenApi> groupedOpenApis,
                                              org.springframework.beans.factory.ObjectFactory<OpenAPIService> defaultOpenAPIBuilder,
                                              AbstractRequestService requestBuilder,
                                              GenericResponseService responseBuilder,
                                              OperationService operationParser,
                                              SpringDocConfigProperties springDocConfigProperties,
                                              SpringDocProviders springDocProviders)
        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
        springDocConfigProperties - the spring doc config properties
    • Method Detail

      • openapiJson

        @GetMapping(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}/{group}",
                    produces="application/json")
        public reactor.core.publisher.Mono<String> openapiJson​(org.springframework.http.server.reactive.ServerHttpRequest serverHttpRequest,
                                                               @Value("${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}")
                                                               String apiDocsUrl,
                                                               @PathVariable
                                                               String group,
                                                               Locale locale)
                                                        throws com.fasterxml.jackson.core.JsonProcessingException
        Openapi json mono.
        Parameters:
        serverHttpRequest - the server http request
        apiDocsUrl - the api docs url
        group - the group
        locale - the locale
        Returns:
        the mono
        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 reactor.core.publisher.Mono<String> openapiYaml​(org.springframework.http.server.reactive.ServerHttpRequest serverHttpRequest,
                                                               @Value("${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}.yaml")
                                                               String apiDocsUrl,
                                                               @PathVariable
                                                               String group,
                                                               Locale locale)
                                                        throws com.fasterxml.jackson.core.JsonProcessingException
        Openapi yaml mono.
        Parameters:
        serverHttpRequest - the server http request
        apiDocsUrl - the api docs url
        group - the group
        locale - the locale
        Returns:
        the mono
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - the json processing exception