Was ist OpenAPI 3.x?
OpenAPI ist die Industrie-Standardspezifikation zur Beschreibung von RESTful-APIs. Früher als Swagger bekannt, ermöglicht sie automatisierte Codegenerierung, Dokumentation und Tests.
OpenAPI ist die Industrie-Standardspezifikation zur Beschreibung von RESTful-APIs. Früher als Swagger bekannt, ermöglicht sie automatisierte Codegenerierung, Dokumentation und Tests.
OpenAPI bietet ein maschinenlesbares Format zur Beschreibung von HTTP-APIs und ermöglicht Tools, automatisch Code, Dokumentation und Testsuiten zu generieren.
Swagger 1.x und 2.x legten den Grundstein für API-Beschreibungsformate. Die Spezifikation wurde 2015 an die OpenAPI Initiative übergeben und entwickelte sich zu OpenAPI 3.x weiter.
Der aktuelle Standard unterstützt JSON- und YAML-Formate, erweiterte Schemadefinitionen, mehrere Authentifizierungsschemata, Webhooks und Verknüpfungen zwischen Operationen.
sgcOpenAPI parst jede OpenAPI- oder Swagger-Spezifikation und generiert nativen Object-Pascal-Code — und gibt Delphi-Entwicklern erstklassiges API-Tooling.
Pfade, HTTP-Methoden (GET, POST, PUT, DELETE), Query-Parameter, Header und Request-Bodies werden alle in einem strukturierten Format definiert.
Datentypen, Objekteigenschaften, Arrays, Enumerationen und Komposition (allOf, oneOf, anyOf) beschreiben die Form von Request- und Response-Payloads.
API-Schlüssel, OAuth-2.0-Flows, HTTP-Bearer-Tokens und OpenID Connect werden als wiederverwendbare Security-Schemata definiert und auf Operationen angewendet.