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 and Description

MultipleOpenApiWebMvcResource(List<GroupedOpenApi> groupedOpenApis, org.springframework.beans.factory.ObjectFactory<OpenAPIService> defaultOpenAPIBuilder, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders, SpringDocCustomizers springDocCustomizers) Instantiates a new Multiple open api resource.

Method Summary

Modifier and Type	Method and Description
byte[]	openapiJson(javax.servlet.http.HttpServletRequest request, String apiDocsUrl, String group, Locale locale) Openapi json string.
byte[]	openapiYaml(javax.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 Detail

MultipleOpenApiWebMvcResource

public MultipleOpenApiWebMvcResource(List<GroupedOpenApi> groupedOpenApis,
                                     org.springframework.beans.factory.ObjectFactory<OpenAPIService> defaultOpenAPIBuilder,
                                     AbstractRequestService requestBuilder,
                                     GenericResponseService responseBuilder,
                                     OperationService operationParser,
                                     SpringDocConfigProperties springDocConfigProperties,
                                     SpringDocProviders springDocProviders,
                                     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 Detail

openapiJson

@GetMapping(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}/{group}",
            produces="application/json")
public byte[] openapiJson(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                   @Value(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 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.Constants).DEFAULT_API_DOCS_URL}}.yaml/{group}",
            produces="application/vnd.oai.openapi")
public byte[] openapiYaml(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                   @Value(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 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