Package de.svws_nrw.transpiler.typescript

Klasse ApiMethod

java.lang.Object
de.svws_nrw.transpiler.typescript.ApiMethod
public final class ApiMethod extends Object
Diese Klasse analysiert den Java-Code einer OpenAPI-Methode und stellt die Informationen für den Transpiler zur Verfügung.

  • Felddetails

    • api

      public final String api
      Der Name der API, dem diese API-Methode zugeordnet ist

    • name

      public final String name
      Der Name der API-Methode

    • path

      public final String path
      Die URL auf welche die API-Methode angewendet wird

    • httpMethod

      public final ApiHttpMethod httpMethod
      Der Typ der verwendeten HTTP-Methode

    • producesFirst

      public final ApiMimeType producesFirst
      Der erste Mime-Type, welcher für das Ergebnis der API-Methode bei dem Transpiler verwendet wird.

    • produces

      public final List<ApiMimeType> produces
      Die Mime-Types, welche für die Ergebnisse der API-Methode verwendet werden können.

    • consumesFirst

      public final ApiMimeType consumesFirst
      Der erste Mime-Type, welcher für den Input der API-Methode bei dem Transpiler verwendet wird.

    • consumes

      public final List<ApiMimeType> consumes
      Die Mime-Types, welche für den Input der API-Methode verwendet werden können.

    • docSummary

      public final String docSummary
      Dokumentation der Methode: Eine kurze Zusammenfassung

    • docDescription

      public final String docDescription
      Dokumentation der Methode: Eine ausführlichere Beschreibung

    • responses

      public final List<ApiResponse> responses
      Die unterschiedlichen HTTP-Responses, welche beim Aufruf der Methode auftreten können und dokumentiert wurden.

    • returnResponse

      public final ApiResponse returnResponse
      Die HTTP-Response, welche im Erfolgsfall verwendet wird.

    • requestBody

      public final ApiRequestBody requestBody
      Der Request-Body der API-Methode

    • pathParams

      public final ApiPathParams pathParams
      Die Pfad-Parameter dieser API-Methode

  • Methodendetails

    • getMethod

      public static ApiMethod getMethod(Transpiler transpiler, ApiClassAnnotations classAnnotations, ClassTree classTree, MethodTree method)
      Erstellt ein neues Objekt dieser Klasse durch Analyse der übergebenen Java-Methode.
      Parameter:
      transpiler - der zu verwendende Transpiler
      classAnnotations - die Informationen zu den Annotationen der API-Klasse
      classTree - die Java-API-Klasse, in welcher die API-Methode implementiert wurde
      method - die Java-API-Methode
      Gibt zurück:
      das neue Objekt

    • getImportsRequired

      public Map<String,String> getImportsRequired()
      Gibt die von dieser Klasse benötigten Klassen-Imports zurück.
      Gibt zurück:
      eine Map mit den benötigten Imports, d.h. Paare von Klassennamen und der Paketnamen

    • getJSDoc

      public String getJSDoc()
      Erstellt zu dieser Methode den JSDoc-Kommentar
      Gibt zurück:
      der JSDoc-Kommentar

    • getReturnType

      public String getReturnType()
      Gibt den Return-Typ für diese Methode zurück. Dies ist immer eine Promise.
      Gibt zurück:
      ein String mit dem Return-Typ

    • getRequestBodyType

      public String getRequestBodyType()
      Gibt den Typen des Request-Body zurück. Wurde kein Typ spezifiziert, so wird null zurückgegeben.
      Gibt zurück:
      der Typ des Request-Body

    • getTSMethod

      public String getTSMethod()
      Gibt den Type-Script-Code für diese API-Methode zurück.
      Gibt zurück:
      der Type-Script-Code dieser Methode

    • isTranspilable

      public boolean isTranspilable()
      Prüft, ob die API-Methode von dem Transpiler transpiliert werden kann.
      Gibt zurück:
      true, falls die Methode vermutlich transpiliert werden kann und false, falls bekannte Gründe dagegen sprechen (siehe Implementierung)