Package de.svws_nrw.api.debug

Klasse APIDebug

java.lang.Object
de.svws_nrw.api.debug.APIDebug
@Path("") public class APIDebug extends Object
Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf die Debug-API. Die Debug-API stellt die einzelnen HTML-, CSS- und JS-Dateien für die Swagger-UI zur Verfügung. Diese werden automatisiert so angepasst, dass die OpenAPI-Spezifikation genutzt wird, die von diesem SVWS-Server generiert wurde.

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    APIDebug()
    Leerer Standardkonstruktor.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    jakarta.ws.rs.core.Response
    debugFile(String yaml, String api, String filename, jakarta.servlet.http.HttpServletRequest request)
    Diese Methode gibt die für den SVWS-Server angepasste Datei der Swagger-UI zurück.
    jakarta.ws.rs.core.Response
    debugRootWrong(String yaml, jakarta.servlet.http.HttpServletRequest request)
    Führt ein Redirect auf die "/debug/index.html" durch, falls auf "/debug" zugegriffen wird und auf "/debug/yaml/index.html", falls auf "debug/yaml" zugegriffen wird.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • APIDebug

      public APIDebug()
      Leerer Standardkonstruktor.

  • Methodendetails

    • debugRootWrong

      @GET @Produces("text/html") @Path("/debug{yaml : (/yaml)?}") public jakarta.ws.rs.core.Response debugRootWrong(@PathParam("yaml") String yaml, @Context jakarta.servlet.http.HttpServletRequest request)
      Führt ein Redirect auf die "/debug/index.html" durch, falls auf "/debug" zugegriffen wird und auf "/debug/yaml/index.html", falls auf "debug/yaml" zugegriffen wird.
      Parameter:
      yaml - ist auf "/yaml" gesetzt, wenn auf die Debug-API mithilfe der yaml-OpenAPI-Datei zugegriffen wird.
      request - der HTTP-Request
      Gibt zurück:
      die HTTP-Response für den Redirect

    • debugFile

      @GET @Produces({"text/html","text/javascript","text/css","text/plain"}) @Path("/debug{yaml : (/yaml)?}{api : (/\\w+)?}/{filename}") public jakarta.ws.rs.core.Response debugFile(@PathParam("yaml") String yaml, @PathParam("api") String api, @PathParam("filename") String filename, @Context jakarta.servlet.http.HttpServletRequest request)
      Diese Methode gibt die für den SVWS-Server angepasste Datei der Swagger-UI zurück.
      Parameter:
      yaml - ist auf "/yaml" gesetzt, wenn auf die Debug-API mithilfe der yaml-OpenAPI-Datei zugegriffen wird.
      api - die api, auf welche zugegriffen werden soll
      filename - der Dateiname
      request - der HTTP-Request
      Gibt zurück:
      die HTTP-Response