Package de.svws_nrw.api

Klasse OpenApiServer

java.lang.Object
io.swagger.v3.jaxrs2.integration.resources.BaseOpenApiResource
de.svws_nrw.api.OpenApiServer
@Path("") public class OpenApiServer extends io.swagger.v3.jaxrs2.integration.resources.BaseOpenApiResource
Stellt die OpenAPI-Schnittstelle für die Schema-Root-Applikation zur Verfügung

  • Feldübersicht

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

    configLocation, openApiConfiguration, resourcePackages

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    OpenApiServer()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    getOpenApi(jakarta.ws.rs.core.HttpHeaders headers, jakarta.ws.rs.core.UriInfo uriInfo, String type)
    Stellt die Open-API-Datei zur Verfügung.

    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

    • OpenApiServer

      public OpenApiServer()
      Leerer Standardkonstruktor.

  • Methodendetails

    • getOpenApi

      @GET @Path("/openapi/server.{type:json|yaml}") @Produces({"application/json","application/yaml"}) public jakarta.ws.rs.core.Response getOpenApi(@Context jakarta.ws.rs.core.HttpHeaders headers, @Context jakarta.ws.rs.core.UriInfo uriInfo, @PathParam("type") String type) throws Exception
      Stellt die Open-API-Datei zur Verfügung.
      Parameter:
      headers - die HTTP-Header
      uriInfo - die URI-Informationen
      type - der type der Datei (json oder yaml)
      Gibt zurück:
      die HTTP-Response mit der json oder yaml - Datei.
      Löst aus:
      Exception - im Fehlerfall