org.springdoc.api

Class OpenApiResource

java.lang.Object

org.springdoc.api.OpenApiResource

@RestController
public class OpenApiResource
extends Object

Constructor Summary

Constructors

Constructor and Description
OpenApiResource()

Method Summary

Modifier and Type	Method and Description
String	openapiJson()
String	openapiYaml()

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()
                                                                                                                                                                      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()
                                                                                                                                                                                      throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException