Package de.svws_nrw.api

Klasse OpenApiExternal

java.lang.Object
io.swagger.v3.jaxrs2.integration.resources.BaseOpenApiResource
de.svws_nrw.api.OpenApiExternal
Alle implementierten Schnittstellen:
OpenApiDefinition
@Path("") public class OpenApiExternal extends io.swagger.v3.jaxrs2.integration.resources.BaseOpenApiResource implements OpenApiDefinition
Stellt die OpenAPI-Schnittstelle für die Extern angebotene API zur Verfügung

  • Feldübersicht

    Von Klasse geerbte Felder io.swagger.v3.jaxrs2.integration.resources.BaseOpenApiResource

    configLocation, openApiConfiguration, resourcePackages

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    OpenApiExternal()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    String
    getDescription()
    Die Methode liefert eine Beschreibung zur API zurück.
    io.swagger.v3.oas.models.info.Info
    getInfo()
    Die Methode gibt das Info Objekt zur API zurück.
    io.swagger.v3.oas.models.OpenAPI
    getOpenAPI()
    Die Methode gibt das OpenAPI Objekt zur API zurück.
    io.swagger.v3.oas.integration.api.OpenApiContext
    getOpenApiContext()
    Die Methode gibt das OpenApiContext Objekt der API zurück.
    jakarta.ws.rs.core.Response
    getOpenApiFile(String type)
    Die Methode liefert die OpenAPI-Datei.
    io.swagger.v3.oas.integration.SwaggerConfiguration
    getSwaggerConfiguration()
    Die Methode gibt das SwaggerConfiguration Objekt zur API zurück.
    String
    getTitle()
    Die Methode liefert einen Titel zur API zurück.

    Von Klasse geerbte Methoden io.swagger.v3.jaxrs2.integration.resources.BaseOpenApiResource

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

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • OpenApiExternal

      public OpenApiExternal()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getOpenApiFile

      @GET @Path("/openapi/external.{type:json|yaml}") public jakarta.ws.rs.core.Response getOpenApiFile(@PathParam("type") String type) throws io.swagger.v3.oas.integration.OpenApiConfigurationException, com.fasterxml.jackson.core.JsonProcessingException
      Die Methode liefert die OpenAPI-Datei.
      Angegeben von:
      getOpenApiFile in Schnittstelle OpenApiDefinition
      Parameter:
      type - der Typ der Datei (json oder yaml)
      Gibt zurück:
      die HTTP-Response mit der json oder yaml - OpenAPI-Datei.
      Löst aus:
      io.swagger.v3.oas.integration.OpenApiConfigurationException - im Fehlerfall
      com.fasterxml.jackson.core.JsonProcessingException - im Fehlerfall

    • getTitle

      public String getTitle()
      Die Methode liefert einen Titel zur API zurück.
      Angegeben von:
      getTitle in Schnittstelle OpenApiDefinition
      Gibt zurück:
      Titel der API

    • getDescription

      public String getDescription()
      Die Methode liefert eine Beschreibung zur API zurück.
      Angegeben von:
      getDescription in Schnittstelle OpenApiDefinition
      Gibt zurück:
      Beschreibungstext der API

    • getInfo

      public io.swagger.v3.oas.models.info.Info getInfo()
      Die Methode gibt das Info Objekt zur API zurück.
      Angegeben von:
      getInfo in Schnittstelle OpenApiDefinition
      Gibt zurück:
      Info Objekt

    • getOpenAPI

      public io.swagger.v3.oas.models.OpenAPI getOpenAPI()
      Die Methode gibt das OpenAPI Objekt zur API zurück.
      Angegeben von:
      getOpenAPI in Schnittstelle OpenApiDefinition
      Gibt zurück:
      OpenAPI Objekt

    • getSwaggerConfiguration

      public io.swagger.v3.oas.integration.SwaggerConfiguration getSwaggerConfiguration()
      Die Methode gibt das SwaggerConfiguration Objekt zur API zurück.
      Angegeben von:
      getSwaggerConfiguration in Schnittstelle OpenApiDefinition
      Gibt zurück:
      SwaggerConfiguration Objekt

    • getOpenApiContext

      public io.swagger.v3.oas.integration.api.OpenApiContext getOpenApiContext() throws io.swagger.v3.oas.integration.OpenApiConfigurationException
      Die Methode gibt das OpenApiContext Objekt der API zurück.
      Angegeben von:
      getOpenApiContext in Schnittstelle OpenApiDefinition
      Gibt zurück:
      OpenApiContext Objekt
      Löst aus:
      io.swagger.v3.oas.integration.OpenApiConfigurationException - im Fehlerfall