Package org.springdoc.webflux.api

Class MultipleOpenApiActuatorResource

java.lang.Object
org.springdoc.webflux.api.MultipleOpenApiResource
org.springdoc.webflux.api.MultipleOpenApiActuatorResource
All Implemented Interfaces:
org.springframework.beans.factory.InitializingBean
@RestControllerEndpoint(id="openapi") public class MultipleOpenApiActuatorResource extends MultipleOpenApiResource
The type Multiple open api actuator resource.
Author:
bnasslashen

  • Constructor Summary

    Constructors
    Constructor
    Description
    MultipleOpenApiActuatorResource(List<org.springdoc.core.models.GroupedOpenApi> groupedOpenApis, org.springframework.beans.factory.ObjectFactory<org.springdoc.core.service.OpenAPIService> defaultOpenAPIBuilder, 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 Multiple open api resource.

  • Method Summary

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

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

    afterPropertiesSet, getOpenApiResourceOrThrow

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • MultipleOpenApiActuatorResource

      public MultipleOpenApiActuatorResource(List<org.springdoc.core.models.GroupedOpenApi> groupedOpenApis, org.springframework.beans.factory.ObjectFactory<org.springdoc.core.service.OpenAPIService> defaultOpenAPIBuilder, 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 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
      springDocProviders - the spring doc providers
      springDocCustomizers - the spring doc customizers

  • Method Details

    • openapiJson

      @GetMapping(value="/{group}", produces="application/json") public reactor.core.publisher.Mono<byte[]> openapiJson(org.springframework.http.server.reactive.ServerHttpRequest serverHttpRequest, @Value("${springdoc.api-docs.path:#{T(org.springdoc.core.utils.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="/{group}/yaml", produces="application/vnd.oai.openapi") public reactor.core.publisher.Mono<byte[]> openapiYaml(org.springframework.http.server.reactive.ServerHttpRequest serverHttpRequest, @Value("${springdoc.api-docs.path:#{T(org.springdoc.core.utils.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