Package de.svws_nrw.api

Schnittstelle OpenApiDefinition

Alle bekannten Implementierungsklassen:
OpenApiExternal, OpenApiSchemaRoot, OpenApiServer
public interface OpenApiDefinition

  • 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.
    default 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.

  • Methodendetails

    • getTitle

      String getTitle()
      Die Methode liefert einen Titel zur API zurück.
      Gibt zurück:
      Titel der API

    • getDescription

      String getDescription()
      Die Methode liefert eine Beschreibung zur API zurück.
      Gibt zurück:
      Beschreibungstext der API

    • getInfo

      io.swagger.v3.oas.models.info.Info getInfo()
      Die Methode gibt das Info Objekt zur API zurück.
      Gibt zurück:
      Info Objekt

    • getOpenAPI

      io.swagger.v3.oas.models.OpenAPI getOpenAPI()
      Die Methode gibt das OpenAPI Objekt zur API zurück.
      Gibt zurück:
      OpenAPI Objekt

    • getSwaggerConfiguration

      io.swagger.v3.oas.integration.SwaggerConfiguration getSwaggerConfiguration()
      Die Methode gibt das SwaggerConfiguration Objekt zur API zurück.
      Gibt zurück:
      SwaggerConfiguration Objekt

    • getOpenApiContext

      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.
      Gibt zurück:
      OpenApiContext Objekt
      Löst aus:
      io.swagger.v3.oas.integration.OpenApiConfigurationException - im Fehlerfall

    • getOpenApiFile

      @Produces({"application/json","application/yaml"}) default 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.
      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