Czym jest OpenAPI 3.x?
OpenAPI to branżowy standard specyfikacji do opisywania interfejsów API RESTful. Dawniej znany jako Swagger, umożliwia automatyczne generowanie kodu, dokumentacji i testów.
OpenAPI to branżowy standard specyfikacji do opisywania interfejsów API RESTful. Dawniej znany jako Swagger, umożliwia automatyczne generowanie kodu, dokumentacji i testów.
OpenAPI zapewnia czytelny maszynowo format opisu interfejsów API HTTP, dzięki któremu narzędzia mogą automatycznie generować kod, dokumentację i zestawy testów.
Swagger 1.x i 2.x położyły fundamenty pod formaty opisu API. Specyfikacja została przekazana OpenAPI Initiative w 2015 roku i ewoluowała w OpenAPI 3.x.
Obecny standard obsługuje formaty JSON i YAML, zaawansowane definicje schematów, wiele schematów uwierzytelniania, webhooki oraz powiązania między operacjami.
sgcOpenAPI analizuje dowolną specyfikację OpenAPI lub Swagger i generuje natywny kod Object Pascal — zapewniając programistom Delphi narzędzia do API najwyższej klasy.
Ścieżki, metody HTTP (GET, POST, PUT, DELETE), parametry zapytania, nagłówki i treści żądań są definiowane w ustrukturyzowanym formacie.
Typy danych, właściwości obiektów, tablice, wyliczenia i kompozycja (allOf, oneOf, anyOf) opisują kształt ładunków żądań i odpowiedzi.
Klucze API, przepływy OAuth 2.0, tokeny HTTP Bearer i OpenID Connect są definiowane jako wielokrotnego użytku schematy bezpieczeństwa stosowane do operacji.