API-Dokumentatioun

D'Raisetalk-API am OpenAPI-Format: Dokumentatioun, déi aus dem Code generéiert gëtt, a Generéiere vun engem Client-SDK an der Sprooch vun Ärer Wiel.

Déi komplett Dokumentatioun ass an der Raisetalk-App disponibel. D'Dokumentatioun an der App opmaachen

OpenAPI-Dokumentatioun

Déi komplett Dokumentatioun vun der Raisetalk-API steet am OpenAPI-Format op dëser Adress zur Verfügung: https://api.raisetalk.com/docs.

Si gëtt aus dem Quellcode vun der API automatesch generéiert a bei all Deployment aktualiséiert. Dat garantéiert, datt se ëmmer trei dat tatsächlecht Verhale vun den exponéierten Endpoints erëmspigelt.

De Spezifikatiounsfichier selwer ass och op der Adress https://api.raisetalk.com/openapi.yaml disponibel.

En SDK generéieren

Op Basis vun dëser OpenAPI-Spezifikatioun kënnt Dir mam Tool openapi-generator-cli einfach e Client-SDK a bal all Programméiersprooch (PHP, Python, TypeScript, Java, Go, Ruby, C#, asw.) generéieren.

Beispill fir e PHP-SDK ze generéieren:

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

Fir eng aner Zilsprooch ze wielen, geet et duer, de Wäert vum Parameter -g z'änneren (zum Beispill -g python, -g typescript-axios, -g java, asw.).

Déi komplett Lëscht vun den disponibele Generatoren an déi detailléiert Dokumentatioun vum Tool fannt Dir op der offizieller Websäit: https://openapi-generator.tech/.