org.springdoc.api

Class OpenApiResource

java.lang.Object

org.springdoc.api.AbstractOpenApiResource

org.springdoc.api.OpenApiResource

@RestController
public class OpenApiResource
extends AbstractOpenApiResource

Field Summary

Fields inherited from class org.springdoc.api.AbstractOpenApiResource

infoBuilder, openAPIBuilder, operationParser, requestBuilder, responseBuilder, tagbuiBuilder

Constructor Summary

Constructors

Constructor and Description
OpenApiResource()

Method Summary

Modifier and Type	Method and Description
String	openapiJson(javax.servlet.http.HttpServletRequest request, String apiDocsUrl)
String	openapiYaml(javax.servlet.http.HttpServletRequest request, String apiDocsUrl)

Methods inherited from class org.springdoc.api.AbstractOpenApiResource

buildPathItem, calculatePath

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenApiResource

public OpenApiResource()

Method Detail

openapiJson

@GetMapping(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}",
            produces="application/json")
public String openapiJson(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                             @Value(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}")
                                                                                                                                                                             String apiDocsUrl)
                                                                                                                                                                      throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

openapiYaml

@GetMapping(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}.yaml",
            produces="application/vnd.oai.openapi")
public String openapiYaml(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                             @Value(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}.yaml")
                                                                                                                                                                                             String apiDocsUrl)
                                                                                                                                                                                      throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException