Krok 6. Opublikuj interfejs API

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

W tym kroku opublikujesz interfejs API w portalu, wykonując te czynności:
1. Utwórz specyfikację OpenAPI
2. Utwórz proxy interfejsu API na podstawie specyfikacji
3. Utwórz usługę API
4. Opublikuj interfejs API w portalu

Krok 1. Utwórz specyfikację OpenAPI

Każda specyfikacja OpenAPI jest źródłem informacji w całym cyklu życia interfejsu API. Ta sama specyfikacja jest używana na każdym etapie cyklu życia interfejsu API – od tworzenia po publikowanie.

Aby utworzyć specyfikację OpenAPI:

1. W panelu nawigacyjnym po lewej stronie kliknij Develop (Tworzenie) > Specs (Specyfikacje) , aby otworzyć stronę Specs (Specyfikacje).
2. Kliknij + Spec (Specyfikacja) > Import URL (Importuj adres URL).
3. W oknie importu wpisz te informacje:
4. Import name (Nazwa importu): helloworld

5. Import Url (Importuj adres URL): https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

6. Kliknij Import (Importuj).

Krok 2. Utwórz proxy interfejsu API na podstawie specyfikacji

Utwórz proxy interfejsu API na podstawie specyfikacji OpenAPI, która opisuje interfejs API.

Aby utworzyć proxy interfejsu API na podstawie specyfikacji OpenAPI:

1. Na stronie Specs (Specyfikacje) najedź kursorem na specyfikację helloworld, aby wyświetlić menu działań.
2. Kliknij , aby wygenerować proxy interfejsu API na podstawie specyfikacji.
   Otworzy się kreator Build a Proxy (Utwórz proxy), a strona z informacjami zostanie wstępnie wypełniona wartościami ze specyfikacji OpenAPI.
3. Edytuj pole Description (Opis) w ten sposób: API proxy for hello world (Proxy interfejsu API dla „Hello World”).
4. Kliknij Next (Dalej).

5. Na stronie Policies (Zasady):

   • W sekcji Security: Authorization (Bezpieczeństwo: autoryzacja) wybierz Pass through (no authorization) (Przekaż dalej (bez autoryzacji)).
   • W sekcji Security: Browser (Bezpieczeństwo: przeglądarka) wybierz Add CORS headers (Dodaj nagłówki CORS) .

   

6. Kliknij Next (Dalej).

7. Na stronie Flows (Przepływy) upewnij się, że wszystkie operacje są zaznaczone, i kliknij Next (Dalej).
   

8. Na stronie Virtual Hosts (Hosty wirtualne) upewnij się, że wszystkie hosty wirtualne są zaznaczone, i kliknij Next (Dalej).

9. Na stronie Summary (Podsumowanie) w sekcji Optional Deployment (Opcjonalne wdrożenie) wybierz środowisko, w którym chcesz wdrożyć.

   

10. Kliknij Create (Utwórz).

Na stronie Summary (Podsumowanie) zobaczysz potwierdzenie, że nowe proxy interfejsu API zostało utworzone i wdrożone w środowisku testowym.

Krok 3. Utwórz usługę API

Utwórz usługę API, która zawiera zasoby interfejsu API, które chcesz udostępnić użytkownikom interfejsu API.

Aby utworzyć usługę API:

1. W panelu nawigacyjnym po lewej stronie kliknij Publish (Opublikuj) > API Products (Usługi API) , aby otworzyć stronę API Products (Usługi API).
2. Kliknij + API Product.
   Wyświetli się strona produktu.
3. Wpisz Product Details (Szczegóły usługi).
   Uwaga: domyślnie po opublikowaniu usługi API w portalu wyświetlają się pola Display Name (Wyświetlana nazwa) i Description (Opis). Wartości możesz edytować w kroku 4. Opublikuj interfejs API w portalu.
   

   Pole	Wartość
   Name (Nazwa)	Hello World
   Display Name (Wyświetlana nazwa)	Hello World
   Description (Opis)	Simple hello world example (Prosty przykład „Hello World”)
   Environment (Środowisko)	Wybierz środowisko, w którym wdrożono proxy interfejsu API.
   Access (Dostęp)	Public (Publiczny)
   Automatically approve access requests (Automatycznie zatwierdzaj prośby o dostęp)	Enabled (Włączono)
   Quota	(pozostaw puste)
   Allowed OAuth Scopes (Dozwolone zakresy OAuth)	(pozostaw puste)

4. W sekcji API resources (Zasoby interfejsu API) kliknij Add a proxy (Dodaj proxy), aby określić proxy interfejsu API, które chcesz dodać do usługi API.
   Wyświetli się okno Add API Resource (Dodaj zasób interfejsu API).
5. Kliknij API Proxy (Proxy interfejsu API) (jeśli nie jest jeszcze zaznaczone) i wybierz Mock-Target-API z listy.
6. Kliknij Add (Dodaj).
7. Kliknij Save (Zapisz) , aby zapisać usługę API.

   

Krok 4. Opublikuj interfejs API w portalu

Opublikuj interfejs API w portalu, aby klienci mogli się o nim dowiedzieć i z niego korzystać.

Aby opublikować interfejs API w portalu:

1. Otwórz stronę interfejsów API w portalu:
   1. W panelu nawigacyjnym po lewej stronie kliknij Publish (Opublikuj) > Portals (Portale).
   2. Kliknij wiersz My first portal (Mój pierwszy portal) , aby otworzyć portal.
   3. Kliknij API catalog (Katalog interfejsów API) , aby wyświetlić stronę interfejsów API.
2. Kliknij +.
3. W oknie Add an API product to the catalog (Dodaj usługę API do katalogu) kliknij Hello World i kliknij Next (Dalej).
4. W sekcji API details (Szczegóły interfejsu API) skonfiguruj te opcje:
   • Aby opublikować interfejs API w portalu, kliknij Published (listed in the catalog) (Opublikowany (widoczny w katalogu)).
   • W przypadku Display image (Obraz wyświetlany):
     1. Kliknij Select image (Wybierz obraz).
     2. Na liście istniejących obrazów w oknie Select image (Wybierz obraz) kliknij home-background.jpg.
     3. Kliknij Select (Wybierz).
     4. Wyświetl podgląd obrazu i kliknij Select (Wybierz).
   • W przypadku Categories (Kategorie) wpisz Get Started (Pierwsze kroki) i naciśnij Enter.

   Pozostaw wszystkie inne wartości domyślne.

5. W sekcji dokumentacja API, aby automatycznie wygenerować dokumentację API na podstawie zrzutu specyfikacji OpenAPI Specification:
   1. Kliknij OpenAPI document (Dokument OpenAPI).
   2. Kliknij Select Document (Wybierz dokument).
   3. Kliknij kartę My Specs (Moje specyfikacje) (jeśli nie jest jeszcze wybrana).
   4. Na liście specyfikacji kliknij helloworld.
   5. Kliknij Select (Wybierz).
6. Kliknij Save (Zapisz) , aby zapisać szczegóły interfejsu API.

   

Aby wyświetlić dokumentację API:

1. Kliknij Live Portal (Aktywny portal) , aby wyświetlić zmiany w aktywnym portalu (lub odśwież aktywny portal, jeśli jest już otwarty w innej karcie).
2. Aby wyświetlić opublikowany interfejs API, na pasku nawigacyjnym u góry kliknij APIs (Interfejsy API).
3. Aby wyświetlić dokumentację interfejsu API, kliknij kartę Hello World. Wypróbuj interfejs API

---

Gratulacje! Samouczek został ukończony. Potrzebujesz więcej informacji? Otwórz stronę Tworzenie zintegrowanego portalu.