Package dev.getelements.elements.rest

Class Oas3DocumentationResource

java.lang.Object
io.swagger.v3.jaxrs2.integration.resources.BaseOpenApiResource
dev.getelements.elements.rest.Oas3DocumentationResource
@Path("openapi.{type:json|yaml}") public class Oas3DocumentationResource extends io.swagger.v3.jaxrs2.integration.resources.BaseOpenApiResource

  • Field Summary

    Fields inherited from class io.swagger.v3.jaxrs2.integration.resources.BaseOpenApiResource

    configLocation, openApiConfiguration, resourcePackages

  • Constructor Summary

    Constructors
    Constructor
    Description
    Oas3DocumentationResource()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    URI
    getApiOutsideUrl()
     
    io.swagger.v3.oas.models.OpenAPI
    getOpenApiJson(String type, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.Application application, jakarta.servlet.ServletConfig servletConfig)
     
    io.swagger.v3.oas.models.OpenAPI
    getOpenApiYaml(String type, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.Application application, jakarta.servlet.ServletConfig servletConfig)
     
    VersionService
    getVersionService()
     
    void
    setApiOutsideUrl(URI apiOutsideUrl)
     
    void
    setVersionService(VersionService versionService)
     

    Methods inherited from class io.swagger.v3.jaxrs2.integration.resources.BaseOpenApiResource

    configLocation, getConfigLocation, getContextId, getOpenApi, getOpenApiConfiguration, getResourcePackages, openApiConfiguration, resourcePackages, setConfigLocation, setOpenApiConfiguration, setResourcePackages

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Oas3DocumentationResource

      public Oas3DocumentationResource()

  • Method Details

    • getOpenApiJson

      @GET @Produces("application/json") public io.swagger.v3.oas.models.OpenAPI getOpenApiJson(@PathParam("type") String type, @Context jakarta.ws.rs.core.UriInfo uriInfo, @Context jakarta.ws.rs.core.HttpHeaders headers, @Context jakarta.ws.rs.core.Application application, @Context jakarta.servlet.ServletConfig servletConfig) throws io.swagger.v3.oas.integration.OpenApiConfigurationException
      Throws:
      io.swagger.v3.oas.integration.OpenApiConfigurationException

    • getOpenApiYaml

      @GET @Produces("application/yaml") public io.swagger.v3.oas.models.OpenAPI getOpenApiYaml(@PathParam("type") String type, @Context jakarta.ws.rs.core.UriInfo uriInfo, @Context jakarta.ws.rs.core.HttpHeaders headers, @Context jakarta.ws.rs.core.Application application, @Context jakarta.servlet.ServletConfig servletConfig) throws io.swagger.v3.oas.integration.OpenApiConfigurationException
      Throws:
      io.swagger.v3.oas.integration.OpenApiConfigurationException

    • getApiOutsideUrl

      public URI getApiOutsideUrl()

    • setApiOutsideUrl

      @Inject public void setApiOutsideUrl(@Named("dev.getelements.elements.api.url") URI apiOutsideUrl)

    • getVersionService

      public VersionService getVersionService()

    • setVersionService

      @Inject public void setVersionService(VersionService versionService)