Package org.springdoc.webflux.api

Class OpenApiActuatorResource

java.lang.Object
io.swagger.v3.core.filter.SpecFilter
org.springdoc.api.AbstractOpenApiResource
org.springdoc.webflux.api.OpenApiResource
org.springdoc.webflux.api.OpenApiActuatorResource
@RestControllerEndpoint(id="openapi") @ConditionalOnProperty(name="springdoc.enable-default-api-docs", havingValue="true", matchIfMissing=true) public class OpenApiActuatorResource extends OpenApiResource
The type Open api actuator resource.
Author:
bnasslashen

  • Field Summary

    Fields inherited from class org.springdoc.api.AbstractOpenApiResource

    groupName, openAPIService, springDocConfigProperties, springDocCustomizers, springDocProviders

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenApiActuatorResource(String groupName, org.springframework.beans.factory.ObjectFactory<org.springdoc.core.service.OpenAPIService> openAPIBuilderObjectFactory, org.springdoc.core.service.AbstractRequestService requestBuilder, org.springdoc.core.service.GenericResponseService responseBuilder, org.springdoc.core.service.OperationService operationParser, org.springdoc.core.properties.SpringDocConfigProperties springDocConfigProperties, org.springdoc.core.providers.SpringDocProviders springDocProviders, org.springdoc.core.customizers.SpringDocCustomizers springDocCustomizers)
    Instantiates a new Open api actuator resource.
    OpenApiActuatorResource(org.springframework.beans.factory.ObjectFactory<org.springdoc.core.service.OpenAPIService> openAPIBuilderObjectFactory, org.springdoc.core.service.AbstractRequestService requestBuilder, org.springdoc.core.service.GenericResponseService responseBuilder, org.springdoc.core.service.OperationService operationParser, org.springdoc.core.properties.SpringDocConfigProperties springDocConfigProperties, org.springdoc.core.providers.SpringDocProviders springDocProviders, org.springdoc.core.customizers.SpringDocCustomizers springDocCustomizers)
    Instantiates a new Open api actuator resource.

  • Method Summary

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

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

    calculatePath, getPaths, getWebFluxRouterFunctionPaths, openapiJson, openapiYaml

    Methods inherited from class org.springdoc.api.AbstractOpenApiResource

    addHiddenRestControllers, addHiddenRestControllers, addRestControllers, calculatePath, calculatePath, calculatePath, calculatePath, calculateWebhooks, containsResponseBody, customizeOperation, customizeRouterOperation, decode, getActuatorURI, getDefaultAllowedHttpMethods, getOpenApi, getOpenApi, getRouterFunctionPaths, initOpenAPIBuilder, isActuatorRestController, isAdditionalRestController, isConditionToMatch, isFilterCondition, isHiddenRestControllers, isMethodToFilter, isPackageToScan, isPathToMatch, isRestController, mergeRouters, setModelAndViewClass, 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 Details

    • OpenApiActuatorResource

      public OpenApiActuatorResource(String groupName, org.springframework.beans.factory.ObjectFactory<org.springdoc.core.service.OpenAPIService> openAPIBuilderObjectFactory, org.springdoc.core.service.AbstractRequestService requestBuilder, org.springdoc.core.service.GenericResponseService responseBuilder, org.springdoc.core.service.OperationService operationParser, org.springdoc.core.properties.SpringDocConfigProperties springDocConfigProperties, org.springdoc.core.providers.SpringDocProviders springDocProviders, org.springdoc.core.customizers.SpringDocCustomizers springDocCustomizers)
      Instantiates a new Open api actuator 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
      springDocConfigProperties - the spring doc config properties
      springDocProviders - the spring doc providers
      springDocCustomizers - the spring doc customizers

    • OpenApiActuatorResource

      public OpenApiActuatorResource(org.springframework.beans.factory.ObjectFactory<org.springdoc.core.service.OpenAPIService> openAPIBuilderObjectFactory, org.springdoc.core.service.AbstractRequestService requestBuilder, org.springdoc.core.service.GenericResponseService responseBuilder, org.springdoc.core.service.OperationService operationParser, org.springdoc.core.properties.SpringDocConfigProperties springDocConfigProperties, org.springdoc.core.providers.SpringDocProviders springDocProviders, org.springdoc.core.customizers.SpringDocCustomizers springDocCustomizers)
      Instantiates a new Open api actuator resource.
      Parameters:
      openAPIBuilderObjectFactory - the open api builder object factory
      requestBuilder - the request builder
      responseBuilder - the response builder
      operationParser - the operation parser
      springDocConfigProperties - the spring doc config properties
      springDocProviders - the spring doc providers
      springDocCustomizers - the spring doc customizers

  • Method Details

    • openapiJson

      @GetMapping(value="/", produces="application/json") public reactor.core.publisher.Mono<byte[]> openapiJson(org.springframework.http.server.reactive.ServerHttpRequest serverHttpRequest, Locale locale) throws com.fasterxml.jackson.core.JsonProcessingException
      Openapi json mono.
      Parameters:
      serverHttpRequest - the server http request
      locale - the locale
      Returns:
      the mono
      Throws:
      com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

    • openapiYaml

      @GetMapping(value="/yaml", produces="application/vnd.oai.openapi") public reactor.core.publisher.Mono<byte[]> openapiYaml(org.springframework.http.server.reactive.ServerHttpRequest serverHttpRequest, Locale locale) throws com.fasterxml.jackson.core.JsonProcessingException
      Openapi yaml mono.
      Parameters:
      serverHttpRequest - the server http request
      locale - the locale
      Returns:
      the mono
      Throws:
      com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

    • calculateServerUrl

      protected String calculateServerUrl(org.springframework.http.server.reactive.ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale)
      Description copied from class: OpenApiResource
      Calculate server url.
      Overrides:
      calculateServerUrl in class OpenApiResource
      Parameters:
      serverHttpRequest - the server http request
      apiDocsUrl - the api docs url
      locale - the locale
      Returns:
      the string

    • getServerUrl

      protected String getServerUrl(org.springframework.http.server.reactive.ServerHttpRequest serverHttpRequest, String apiDocsUrl)
      Description copied from class: OpenApiResource
      Gets server url.
      Specified by:
      getServerUrl in class OpenApiResource
      Parameters:
      serverHttpRequest - the server http request
      apiDocsUrl - the api docs url
      Returns:
      the server url