Package org.springdoc.webflux.api

Class OpenApiWebfluxResource

java.lang.Object

io.swagger.v3.core.filter.SpecFilter

org.springdoc.api.AbstractOpenApiResource

org.springdoc.webflux.api.OpenApiResource

org.springdoc.webflux.api.OpenApiWebfluxResource

@RestController
public class OpenApiWebfluxResource
extends OpenApiResource

The type Open api resource.

Author:

bnasslahsen

Field Summary

Fields inherited from class org.springdoc.api.AbstractOpenApiResource

groupName, openAPIService, springDocConfigProperties, springDocProviders

Constructor Summary

Constructors

Constructor	Description
OpenApiWebfluxResource(String groupName, org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<OpenApiCustomiser>> openApiCustomisers, Optional<List<OpenApiMethodFilter>> methodFilters, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders)	Instantiates a new Open api webflux resource.
OpenApiWebfluxResource(org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<OpenApiCustomiser>> openApiCustomisers, Optional<List<OpenApiMethodFilter>> methodFilters, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders)	Instantiates a new Open api webflux resource.

Method Summary

Modifier and Type	Method	Description
protected String	getServerUrl(org.springframework.http.server.reactive.ServerHttpRequest serverHttpRequest, String apiDocsUrl)	Gets server url.
reactor.core.publisher.Mono<String>	openapiJson(org.springframework.http.server.reactive.ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale)	Openapi json mono.
reactor.core.publisher.Mono<String>	openapiYaml(org.springframework.http.server.reactive.ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale)	Openapi yaml mono.

Methods inherited from class org.springdoc.webflux.api.OpenApiResource

calculatePath, calculateServerUrl, getPaths, getWebFluxRouterFunctionPaths

Methods inherited from class org.springdoc.api.AbstractOpenApiResource

addHiddenRestControllers, addHiddenRestControllers, addRestControllers, calculatePath, calculatePath, calculatePath, calculatePath, containsResponseBody, customiseOperation, decode, getActuatorURI, getDefaultAllowedHttpMethods, getOpenApi, getRouterFunctionPaths, initOpenAPIBuilder, isActuatorRestController, isAdditionalRestController, isConditionToMatch, isFilterCondition, isHiddenRestControllers, isMethodToFilter, isPackageToScan, isPathToMatch, isRestController, mergeRouters, writeJsonValue, writeYamlValue

Methods inherited from class io.swagger.v3.core.filter.SpecFilter

filter, filterComponentsSchema, filterOpenAPI, filterOperation, filterParameter, filterPathItem, filterRequestBody, filterResponse, locateReferencedDefinitions, removeBrokenReferenceDefinitions, resolveAllNestedRefs

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenApiWebfluxResource

public OpenApiWebfluxResource(String groupName,
                              org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory,
                              AbstractRequestService requestBuilder,
                              GenericResponseService responseBuilder,
                              OperationService operationParser,
                              Optional<List<OperationCustomizer>> operationCustomizers,
                              Optional<List<OpenApiCustomiser>> openApiCustomisers,
                              Optional<List<OpenApiMethodFilter>> methodFilters,
                              SpringDocConfigProperties springDocConfigProperties,
                              SpringDocProviders springDocProviders)

Instantiates a new Open api webflux resource.

Parameters:

groupName - the group name

openAPIBuilderObjectFactory - the open api builder object factory

requestBuilder - the request builder

responseBuilder - the response builder

operationParser - the operation parser

operationCustomizers - the operation customizers

openApiCustomisers - the open api customisers

methodFilters - the method filters

springDocConfigProperties - the spring doc config properties

springDocProviders - the spring doc providers

OpenApiWebfluxResource

@Autowired
public OpenApiWebfluxResource(org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory,
                              AbstractRequestService requestBuilder,
                              GenericResponseService responseBuilder,
                              OperationService operationParser,
                              Optional<List<OperationCustomizer>> operationCustomizers,
                              Optional<List<OpenApiCustomiser>> openApiCustomisers,
                              Optional<List<OpenApiMethodFilter>> methodFilters,
                              SpringDocConfigProperties springDocConfigProperties,
                              SpringDocProviders springDocProviders)

Instantiates a new Open api webflux resource.

Parameters:

openAPIBuilderObjectFactory - the open api builder object factory

requestBuilder - the request builder

responseBuilder - the response builder

operationParser - the operation parser

operationCustomizers - the operation customizers

openApiCustomisers - the open api customisers

methodFilters - the method filters

springDocConfigProperties - the spring doc config properties

springDocProviders - the spring doc providers

Method Detail

openapiJson

@GetMapping(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}",
            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,
                                                       Locale locale)
                                                throws com.fasterxml.jackson.core.JsonProcessingException

Openapi json mono.

Overrides:

openapiJson in class OpenApiResource

Parameters:

serverHttpRequest - the server http request

apiDocsUrl - the api docs url

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",
            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,
                                                       Locale locale)
                                                throws com.fasterxml.jackson.core.JsonProcessingException

Openapi yaml mono.

Overrides:

openapiYaml in class OpenApiResource

Parameters:

serverHttpRequest - the server http request

apiDocsUrl - the api docs url

locale - the locale

Returns:

the mono

Throws:

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

getServerUrl

protected String getServerUrl(org.springframework.http.server.reactive.ServerHttpRequest serverHttpRequest,
                              String apiDocsUrl)

Gets server url.

Specified by:

getServerUrl in class OpenApiResource

Parameters:

serverHttpRequest - the server http request

apiDocsUrl - the api docs url

Returns:

the server url