Tworzenie serwera proxy interfejsów API na podstawie specyfikacji OpenAPI

Z tego samouczka dowiesz się, jak utworzyć serwer proxy interfejsu Edge API z użyciem OpenAPI Specyfikacja przy użyciu interfejsu zarządzania Apigee Edge. Gdy wywołujesz serwer proxy interfejsu API za pomocą klient HTTP, taki jak cURL, serwer proxy interfejsu API wysyła żądanie do pozornego celu Apigee posprzedażna.

Informacje o Open API Initiative

„Inicjatywa Open API Initiative (OAI) koncentruje się na tworzeniu, rozwijaniu i promowaniu niezależnego od dostawcy formatu opisu interfejsu API opartego na Swagger. Specyfikacja”. Więcej informacji o inicjatywie Open API Initiative znajdziesz na stronie https://openapis.org.

Specyfikacja OpenAPI używa standardowego formatu do opisania interfejsu API typu REST. Specyfikacja OpenAPI jest zapisana w formacie JSON lub YAML, aby była zrozumiała dla komputera, ale być łatwe do odczytania i zrozumienia. Specyfikacja opisuje takie elementy API jako ścieżkę podstawową, ścieżki i czasowniki, nagłówki, parametry zapytania, operacje, typy treści opisy odpowiedzi itp. Dodatkowo specyfikacja OpenAPI jest często używana do generowania dokumentacji API.

Informacje o usłudze docelowej Apigee

Usługa docelowa Apigee używana w tym samouczku jest hostowana w Apigee i zwraca proste dane. Nie wymaga klucza API ani tokena dostępu. W praktyce możesz ją otworzyć w przeglądarce, przeglądarki. Aby wypróbować tę funkcję, kliknij:

http://mocktarget.apigee.net

Usługa docelowa zwraca powitanie Hello, guest!

Aby uzyskać informacje dotyczące pełnego zestawu interfejsów API obsługiwanych przez pozorną usługę docelową, kliknij :

http://mocktarget.apigee.net/help

Czego potrzebujesz

• Konto Apigee Edge. Jeśli nie masz konta, możesz się zarejestrować, postępując zgodnie z instrukcje znajdziesz w artykule Tworzenie Apigee Edge .
• Specyfikacja OpenAPI. W tym samouczku będziesz używać interfejsu mocktarget.yaml Specyfikacja OpenAPI opisująca pozorny cel Apigee usługa http://mocktarget.apigee.net. Więcej informacji: https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi
• Aplikacja cURL zainstalowana na Twoim komputerze, aby wykonywać wywołania interfejsu API w wierszu poleceń, lub z przeglądarki.

Tworzenie serwera proxy interfejsu API

Gratulacje! Udało Ci się utworzyć serwer proxy interfejsu API na podstawie specyfikacji OpenAPI. Następnie i zobacz, jak działa.

Testowanie serwera proxy interfejsu API

Interfejs API Mock-Target-API możesz przetestować za pomocą narzędzia cURL lub przeglądarki.

W oknie terminala uruchom następujące polecenie cURL. Zamień nazwę organizacji w: adres URL.

curl http://<org_name>-test.apigee.net/mock-target-api

Odpowiedź

Powinna pojawić się taka odpowiedź:

Hello, Guest!        

Doskonale! Udało Ci się utworzyć prosty serwer proxy interfejsu API na podstawie specyfikacji OpenAPI i przetestować .

Dodaj zasadę XML do kodu JSON

Następnie dodaj zasadę XML do JSON do pola Wyświetl odpowiedź XML przepływ warunkowy, który został wygenerowany automatycznie podczas tworzenia serwera proxy interfejsu API na podstawie Specyfikacja OpenAPI. Zasada konwertuje odpowiedź XML celu na plik JSON .

Najpierw wywołaj interfejs API, aby móc porównać wyniki z tymi otrzymanymi po dodaniu zasady. W oknie terminala wykonaj podane niżej polecenie cURL. Dzwonisz do zasobu /xml usługi docelowej, który natywnie zwraca prosty blok kodu XML. W adresie URL zastąp nazwę organizacji.

curl http://<org_name>-test.apigee.net/mock-target-api/xml

Odpowiedź

Powinna pojawić się taka odpowiedź:

<root> 
  <city>San Jose</city> 
  <firstName>John</firstName> 
  <lastName>Doe</lastName> 
  <state>CA</state> 
</root>

Teraz zróbmy coś, co przekonwertuje odpowiedź XML na format JSON. Dodaj zasadę XML do JSON do procesu warunkowego wyświetlania odpowiedzi XML na serwerze proxy interfejsu API.

1. Kliknij kartę Develop (Programowanie) w prawym górnym rogu interfejsu Mock-Target-API. Strona Przegląd w interfejsie Edge.
   
2. W lewym panelu Nawigator, w sekcji Proxy Endpoints > (Punkty końcowe serwera proxy) kliknij menu Widok Przepływ warunkowy odpowiedzi XML.
   
3. Kliknij dolny przycisk +Krok odpowiadający Odpowiedź na przepływ.
   
   Otworzy się okno Dodaj krok z listą wszystkich zasad, które można zastosować dodaj.
   
4. Przewiń do kategorii Zapośredniczenie i wybierz XML do JSON.
   
5. Zachowaj domyślne wartości pól Wyświetlana nazwa i Nazwa.
6. Kliknij Dodaj. Zasada XML na JSON jest stosowana do odpowiedzi.
7. Kliknij Zapisz.

Po dodaniu zasady ponownie wywołaj interfejs API za pomocą polecenia cURL. Zwróć uwagę, że w dalszym ciągu wywołanie tego samego zasobu /xml. Usługa docelowa nadal zwraca blok XML, ale teraz zasada na serwerze proxy interfejsu API przekonwertuje odpowiedź na format JSON. Zrób to zadzwoń:

curl http://<org_name>-test.apigee.net/mock-target-api/xml

Pamiętaj, że odpowiedź XML jest konwertowana do formatu JSON:

{"root":{"city":"San Jose","firstName":"John","lastName":"Doe","state":"CA"}}

Gratulacje! Udało Ci się przetestować wykonanie zasady dodanej do przepływu warunkowego.