Krok 6. Opublikuj interfejs API

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

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

Krok 1. Utwórz specyfikację OpenAPI

Każda specyfikacja OpenAPI służy jako źródło wiarygodnych informacji przez cały cykl życia interfejsu API. Ta sama specyfikacja jest używana na każdym etapie cyklu życia interfejsu API – od programowania po publikację.

Aby utworzyć specyfikację OpenAPI:

  1. Na pasku nawigacyjnym po lewej stronie wybierz Programowanie > Specyfikacje, aby otworzyć stronę Specyfikacje.
  2. Kliknij + Specyfikacja > Importuj adres URL.
  3. W oknie importowania wpisz te informacje:
  4. Nazwa importu: helloworld

  5. URL importu: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

  6. Kliknij Importuj.

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

Utworzenie serwera proxy interfejsu API na podstawie specyfikacji OpenAPI opisującej interfejs API.

Aby utworzyć serwer proxy interfejsu API na podstawie specyfikacji OpenAPI:

  1. Na stronie Specyfikacja najedź kursorem na specyfikację helloworld, aby wyświetlić menu czynności.
  2. Kliknij , aby wygenerować serwer proxy interfejsu API na podstawie specyfikacji.
    Otworzy się kreator tworzenia serwera proxy, a strona Szczegóły zostanie wstępnie wypełniona wartościami ze specyfikacji OpenAPI.
  3. Zmień pole Opis w ten sposób: Serwer proxy interfejsu API dla hello world.
  4. Kliknij Dalej.

  5. Na stronie Zasady:

    • W sekcji Zabezpieczenia: autoryzacja wybierz Przekazywanie (bez autoryzacji).
    • W sekcji Zabezpieczenia: przeglądarka wybierz Dodaj nagłówki CORS .

    Strona z typowymi zasadami w kreatorze tworzenia serwera proxy z zaznaczonymi nagłówkami Przekazuj i Dodaj nagłówki CORS

  6. Kliknij Dalej.

  7. Na stronie Przepływy sprawdź, czy wszystkie operacje są zaznaczone, i kliknij Dalej.
    Tworzenie przepływów serwera proxy

  8. Na stronie Virtual Hosts (Hosty wirtualne) sprawdź, czy są wybrane wszystkie hosty wirtualne, i kliknij Next (Dalej).

  9. Na stronie Podsumowanie w sekcji Wdrożenie opcjonalne wybierz środowisko, w którym chcesz przeprowadzić wdrożenie.

  10. Kliknij Utwórz.

Na stronie Podsumowanie zobaczysz potwierdzenie, że nowy serwer proxy interfejsu API został utworzony i wdrożony w środowisku testowym.

Krok 3. Utwórz usługę API

Utwórz usługę API zawierającą zasoby interfejsu API, które chcesz udostępnić klientom korzystającym z interfejsu API.

Aby utworzyć usługę API:

  1. Na pasku nawigacyjnym po lewej stronie wybierz Opublikuj > Usługi API, aby otworzyć stronę Usługi API.
  2. Kliknij + Usługa API.
    Wyświetli się strona Nowy produkt.
  3. Podaj Szczegóły produktu w interfejsie API.
    Uwaga: pola Nazwa wyświetlana i Opis są domyślnie wyświetlane w portalu podczas publikowania usługi API. Wartości możesz edytować w kroku 4. Opublikuj interfejs API w swoim portalu.
    Field Wartość
    Nazwa Witaj świecie
    Wyświetlana nazwa Witaj świecie
    Opis Przykład witryny Simple hello world
    Środowisko Wybierz środowisko, w którym jest wdrożony serwer proxy interfejsu API.
    Dostęp Publiczny
    Automatyczne zatwierdzanie próśb o dostęp Włączono
    Limit (pozostaw puste)
    Dozwolone zakresy protokołu OAuth (pozostaw puste)
  4. W sekcji Zasoby interfejsu API kliknij Dodaj serwer proxy, aby wskazać serwery proxy interfejsu API, które chcesz dodać do interfejsu API.
    Pojawi się okno Dodaj zasób interfejsu API.
  5. Kliknij opcję API Proxy (Serwer proxy interfejsu API) (jeśli nie jest jeszcze wybrana) i wybierz z listy pozycję Mock-Target-API.
  6. Kliknij Dodaj.
  7. Kliknij Zapisz, aby zapisać usługę API.

    Usługa Hello World API z widocznymi wszystkimi polami

Krok 4. Opublikuj interfejs API w portalu

Opublikuj interfejs API w swoim portalu, aby klienci mogli go poznać i korzystać z niego.

Aby opublikować interfejs API w portalu:

  1. Otwórz w portalu stronę interfejsów API:
    1. Na pasku nawigacyjnym po lewej stronie wybierz Opublikuj > Portale.
    2. Kliknij wiersz Mój pierwszy portal, aby go otworzyć.
    3. Kliknij Katalog interfejsów API, aby wyświetlić stronę interfejsów API.
  2. Kliknij +.
  3. W oknie Dodaj usługę API do katalogu wybierz Hello World i kliknij Dalej.
  4. W sekcji Szczegóły interfejsu API skonfiguruj te opcje:
    • Wybierz Opublikowano (znajduje się w katalogu), aby opublikować interfejs API w swoim portalu.
    • W przypadku opcji Wyświetlany obraz:
      1. Kliknij Wybierz obraz.
      2. Kliknij home-background.jpg na liście istniejących obrazów w oknie Wybierz obraz.
      3. Kliknij Wybierz.
      4. Wyświetl podgląd obrazu i kliknij Wybierz.
    • Jako Kategorie wpisz Rozpocznij i naciśnij Enter.

    Wszystkie inne wartości pozostaw domyślne.

  5. Aby automatycznie wygenerować dokumentację referencyjną interfejsu API na podstawie zrzutu specyfikacji OpenAPI, zapoznaj się z dokumentacją interfejsu API:
    1. Wybierz Dokument OpenAPI.
    2. Kliknij Wybierz dokument.
    3. Wybierz kartę My Specifications (Moje specyfikacje), jeśli nie jest jeszcze wybrana.
    4. Z listy specyfikacji wybierz helloworld.
    5. Kliknij Wybierz.
  6. Kliknij Zapisz, aby zapisać szczegóły interfejsu API.

    Interfejs Hello World API przedstawiający wszystkie ustawione pola

Aby wyświetlić dokumentację API:

  1. Kliknij Aktywny portal, aby zobaczyć zmiany w opublikowanym portalu (lub odśwież, jeśli jest już otwarty na innej karcie).
  2. Kliknij Interfejsy API na górnym pasku nawigacyjnym, aby wyświetlić opublikowany interfejs API.
  3. Kliknij kartę Hello World, aby wyświetlić dokumentację API. Wypróbuj swój interfejs API.

Opublikowano próbkę interfejsu API docelowego z użyciem panelu Wypróbuj ten interfejs API

Gratulacje! Udało Ci się ukończyć samouczek. Potrzebujesz więcej informacji? Przejdź do sekcji Tworzenie zintegrowanego portalu.