Specyfikacja OpenAPI, wcześniej znana jako specyfikacja Swagger, to specyfikacja maszynowo czytelnych plików interfejsu do opisywania, tworzenia, konsumowania i wizualizacji usług RESTful. Wcześniej część frameworka Swagger, stała się osobnym projektem w 2016 roku, nadzorowanym przez OpenAPI Initiative — projekt współpracy open-source Linux Foundation. Swagger i inne narzędzia mogą generować kod, dokumentację i przypadki testowe na podstawie pliku interfejsu.
Aplikacje zbudowane na podstawie plików interfejsu OpenAPI mogą automatycznie generować dokumentację metod, parametrów i modeli. Pomaga to utrzymać dokumentację, biblioteki klienta i kod źródłowy w synchronizacji.
Wydano nowy OpenAPI WebService (obecnie BETA), który odczytuje specyfikację OpenAPI 3.0 w formacie JSON i automatycznie tworzy klienta Delphi w natywnym kodzie Pascal. WebService tworzy demo, które pokazuje, jak współpracować z API.
WebService wymaga, aby specyfikacja była w wersji 3.0+ i w formacie JSON.
Importowanie specyfikacji OpenAPI
The first step is import the openAPI 3.0 specification, to do this I will use a simple openAPI specification used by abstractapi.com to retrieve the location of an IP Address. Poniżej znajdziesz the specification file:
Gdy masz już specyfikację openAPI 3.0 w formacie JSON, możesz wygenerować wymagane pliki Delphi przy użyciu naszego OpenAPI WebService — wejdź pod następujący URL:
https://www.esegece.com/products/openapi/ws/demo
Po prostu ustaw nazwę klasy (domyślnie TsgcOpenAPI_Test) i prześlij plik specyfikacji (najpierw rozpakuj go!!!, musi być w formacie JSON). Na końcu naciśnij przycisk Upload , aby przetworzyć plik.
Jeśli proces zakończy się sukcesem, zostanie pobrany nowy spakowany plik ze skompilowanym demo.
Test demo openAPI
Przed przetestowaniem demo musisz utworzyć bezpłatne konto w abstractapi.com, aby uzyskać klucz API.
https://app.abstractapi.com/users/signup
Rozpakuj pobrany plik i przejdź do folderu Demo — znajdziesz tam plik sgcOpenAPIDemo.exe; uruchom go.
Pojawi się nowe okno, które pokazuje URL Abstractapi.com.
Naciśnij przycisk dalej i wybierz metodę Retrieve_the_location_of_an_IP_address, a następnie wypełnij Api_Key oraz adres IP do wyszukania. Jeśli żądanie zostanie pomyślnie przetworzone, zwrócona zostanie wiadomość JSON z informacjami o adresie IP.
Poniżej znajdziesz the compressed generated automatically the sgcOpenAPI WebService to do the tests.