Package org.springdoc.webmvc.api

Class MultipleOpenApiWebMvcResource

java.lang.Object
org.springdoc.webmvc.api.MultipleOpenApiResource
org.springdoc.webmvc.api.MultipleOpenApiWebMvcResource
All Implemented Interfaces:
org.springframework.beans.factory.InitializingBean
@RestController public class MultipleOpenApiWebMvcResource extends MultipleOpenApiResource
The type Multiple open api resource.
Author:
bnasslahsen

  • Constructor Summary

    Constructors
    Constructor
    Description
    MultipleOpenApiWebMvcResource(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
    byte[]
    openapiJson(jakarta.servlet.http.HttpServletRequest request, String apiDocsUrl, String group, Locale locale)
    Openapi json string.
    byte[]
    openapiYaml(jakarta.servlet.http.HttpServletRequest request, String apiDocsUrl, String group, Locale locale)
    Openapi yaml string.

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

    afterPropertiesSet, getOpenApiResourceOrThrow

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • MultipleOpenApiWebMvcResource

      public MultipleOpenApiWebMvcResource(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="${springdoc.api-docs.path:#{T(org.springdoc.core.utils.Constants).DEFAULT_API_DOCS_URL}}/{group}", produces="application/json") public byte[] openapiJson(jakarta.servlet.http.HttpServletRequest request, @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 string.
      Parameters:
      request - the request
      apiDocsUrl - the api docs url
      group - the group
      locale - the locale
      Returns:
      the string
      Throws:
      com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

    • openapiYaml

      @GetMapping(value="${springdoc.api-docs.path:#{T(org.springdoc.core.utils.Constants).DEFAULT_API_DOCS_URL}}.yaml/{group}", produces="application/vnd.oai.openapi") public byte[] openapiYaml(jakarta.servlet.http.HttpServletRequest request, @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 string.
      Parameters:
      request - the request
      apiDocsUrl - the api docs url
      group - the group
      locale - the locale
      Returns:
      the string
      Throws:
      com.fasterxml.jackson.core.JsonProcessingException - the json processing exception