OpenAPI 2.0

Die OpenAPI 2.0 Spezifikation (ehemals Swagger-Spezifikation) ist ein API-Beschreibungsformat für REST-APIs. Eine OpenAPI 2.0 Datei ermöglicht es dir, deine gesamte API zu beschreiben, einschließlich:

• Verfügbare Endpunkte (/users) und Operationen auf jedem Endpunkt (GET /users, POST /users)
• Operationsparameter sowie Anfrage und Antwort für jeden Vorgang
• Authentifizierungsmethoden
• Kontaktinformationen, Lizenz, Nutzungsbedingungen und andere Informationen.

Github

Die Dokumentation der Schnittstelle im OpenAPI 2.0 Format kann über das InterNetX Github Repository bezogen werden.

Anwendungsbeispiele

Automatisch generierte Modelle

Mit dem Swagger Codegen Plugin für Maven können automatisiert Modelle in verschiedenen Programmiersprachen erstellt werden. Diese Modelle können für die Kommunikation mit der Schnittstelle verwendet werden.

OpenAPI 2.0 Dokumentation