OpenAPI-Dokumentation

Die vollständige Dokumentation der Raisetalk-API ist im OpenAPI-Format unter folgender Adresse verfügbar: https://api.raisetalk.com/docs.

Sie wird automatisch aus dem Quellcode der API generiert und bei jedem Deployment aktualisiert, wodurch sichergestellt ist, dass sie stets das tatsächliche Verhalten der exponierten Endpunkte getreu widerspiegelt.

Die Rohdatei der Spezifikation ist ebenfalls unter https://api.raisetalk.com/openapi.yaml abrufbar.

SDK generieren

Auf Basis dieser OpenAPI-Spezifikation lässt sich mit dem Tool openapi-generator-cli einfach ein Client-SDK in nahezu jeder Sprache (PHP, Python, TypeScript, Java, Go, Ruby, C# usw.) generieren.

Beispiel für die Generierung eines PHP-SDK:

docker run --rm \
  -v "${PWD}:/local" \
  openapitools/openapi-generator-cli generate \
  -i https://api.raisetalk.com/openapi.yaml \
  -g php \
  -o /local/sdk/php

Um eine andere Zielsprache zu wählen, genügt es, den Wert des Parameters -g zu ändern (zum Beispiel -g python, -g typescript-axios, -g java usw.).

Die vollständige Liste der verfügbaren Generatoren sowie die ausführliche Dokumentation des Tools finden Sie auf der offiziellen Website: https://openapi-generator.tech/.