Swagger ist eine Sammlung von Open-Source-Tools zur Dokumentation, Gestaltung und zum Testen von REST-APIs. Die OpenAPI-Spezifikation (ehemals Swagger) ist der weltweit meistverwendete API-Beschreibungsstandard.
Was ist Swagger?
Swagger ist ein Ökosystem von Tools für die Konzeption, Dokumentation und das Testen von REST-APIs. Die OpenAPI-Spezifikation (ursprünglich Swagger Specification genannt) ist zum weltweiten Standard für die maschinen- und menschenlesbare Beschreibung von RESTful-APIs geworden.
Die Swagger-Komponenten
- Swagger UI: Interaktive Web-Oberfläche zum Erkunden und Testen der API-Endpoints
- Swagger Editor: Online-Editor zum Schreiben von OpenAPI-Spezifikationen in YAML/JSON
- Swagger Codegen: Automatischer SDK-Client-Generator in über 40 Programmiersprachen
Vorteile von Swagger/OpenAPI
- Lebendige Dokumentation: Die Dokumentation ist immer mit der tatsächlichen API synchronisiert
- Interaktives Testen: Testen Sie jeden Endpoint direkt im Browser
- Code-Generierung: SDK-Clients werden automatisch generiert
Swagger bei AILabsAudit
AILabsAudit bietet eine interaktive Swagger-Dokumentation unter /api/v1/docs. Dort können Sie alle Endpoints erkunden, die Anfrage-/Antwort-Schemas einsehen und Aufrufe direkt mit Ihrem API-Schlüssel testen.