Tooling und OpenAPI

​

In einen API-Client importieren

​

Postman oder Insomnia

1. Laden Sie die JSON- oder YAML-Datei herunter.
2. Importieren Sie sie als OpenAPI-Spezifikation.
3. Konfigurieren Sie https://api.jobhandy.io/v1 als Server, wenn der Client ihn nicht automatisch auswählt.
4. Speichern Sie X-API-Key in der geschützten Umgebung des Clients, nicht in einem gemeinsam genutzten Collection-Export.
5. Fügen Sie X-Tenant-ID nur dort hinzu, wo der Header erforderlich ist.
6. Entfernen oder deaktivieren Sie Beispiel-Secrets, bevor Sie den Workspace teilen.

​

Client erzeugen

npx @openapitools/openapi-generator-cli generate \
  -i jobhandy-public-api.openapi.json \
  -g typescript-fetch \
  -o generated/jobhandy

npx @openapitools/openapi-generator-cli generate \
  -i jobhandy-public-api.openapi.json \
  -g csharp \
  -o generated/jobhandy-csharp

​

Vertragsvalidierung in CI

• OpenAPI-3.1-Validierung ist erfolgreich
• alle $ref-Werte sind auflösbar
• operationId-Werte bleiben eindeutig
• generierter Code kompiliert
• Beispiele entsprechen ihren Schemas
• es treten keine unerwarteten Breaking Changes auf
• der produktive Server bleibt https://api.jobhandy.io/v1
• kein Development- oder Stage-Host wird in Kundenkonfigurationen eingeführt

​

Übernommenen Vertrag pinnen

client release
OpenAPI info.version
file checksum
adoption date
generator and configuration
breaking-change review result