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. Tworzenie serwera proxy interfejsu API na podstawie specyfikacji
3. Tworzenie usługi API
4. Publikowanie interfejsu API w portalu

Krok 1. Utwórz specyfikację OpenAPI

Każda specyfikacja OpenAPI służy jako źródło informacji w trakcie całego cyklu życia interfejsu API. Ta sama specyfikacja jest używana na każdym etapie cyklu życia interfejsu API, od rozwoju do publikacji.

Aby utworzyć specyfikację OpenAPI:

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

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

  6. Kliknij 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 Specyfikacje umieść kursor nad specyfikacją helloworld, aby wyświetlić menu działań.
  2. Kliknij , aby wygenerować na podstawie specyfikacji przekierowanie API.
    Otworzy się kreator tworzenia przekierowania, a na stronie Szczegóły zostaną wstępnie wypełnione 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 Bezpieczeństwo: autoryzacja wybierz Przepuszczanie (bez autoryzacji).
    • W sekcji Bezpieczeństwo: przeglądarka wybierz Dodaj nagłówki CORS .

    Strona wspólnych zasad w kreatorze tworzenia proxy z opcjami Przepuść 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 proxy

  8. Na stronie Wirtualni gospodarze sprawdź, czy wszystkie wirtualne gospodarze są wybrane, a następnie kliknij Dalej.

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

  10. Kliknij Utwórz.

Na stronie podsumowania zobaczysz potwierdzenie, że nowe serwery proxy interfejsu API zostały utworzone i wdrożone w środowisku testowym.

Krok 3. Utwórz usługę API

Utwórz usługę API zawierającą zasoby API, które chcesz udostępnić użytkownikom.

Aby utworzyć usługę API:

  1. Aby otworzyć stronę Produkty API, na pasku nawigacyjnym po lewej stronie kliknij Opublikuj > Produkty API.
  2. Kliknij + Usługa API.
    Otworzy się strona Nowy produkt.
  3. Wpisz szczegóły usługi dla swojej usługi interfejsu API.
    Uwaga: pola Wyświetlana nazwa i Opis są domyślnie wyświetlane w portalu po opublikowaniu produktu interfejsu API. Wartości możesz edytować w kroku 4. Opublikuj interfejs API w portalu.
    Pole Wartość
    Nazwa Hello World
    Wyświetlana nazwa Hello World
    Opis Przykład prostego programu „hello world”
    Środowisko Wybierz środowisko, w którym serwer proxy interfejsu API jest wdrożony.
    Dostęp Publiczny
    Automatyczne zatwierdzanie próśb o dostęp Włączono
    Limit (pozostaw puste)
    Dozwolone zakresy OAuth (pozostaw puste)
  4. W sekcji Zasoby interfejsu API kliknij Dodaj serwer proxy, aby wskazać serwery proxy interfejsu API, które chcesz dodać do produktu interfejsu API.
    Wyświetli się okno Dodaj zasób interfejsu API.
  5. Kliknij Proxy API (jeśli nie jest już wybrane) i na liście wybierz Mock-Target-API.
  6. Kliknij Dodaj.
  7. Aby zapisać produkt interfejsu API, kliknij Zapisz.

    Produkt Hello World API pokazujący wszystkie ustawione pola

Krok 4. Opublikuj interfejs API w portalu

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

Aby opublikować interfejs API w portalu:

  1. Otwórz stronę interfejsów API w portalu:
    1. Na pasku nawigacyjnym po lewej stronie kliknij Opublikuj > Portale.
    2. Kliknij w wierszu Mój pierwszy portal, aby otworzyć portal.
    3. Kliknij Katalog interfejsów API, aby wyświetlić stronę interfejsów API.
  2. Kliknij +.
  3. W oknie Dodaj produkt interfejsu API do katalogu wybierz Hello World i kliknij Dalej.
  4. W sekcji Szczegóły interfejsu API skonfiguruj te opcje:
    • Aby opublikować interfejs API w portalu, wybierz Opublikowane (wymienione w katalogu).
    • W przypadku wyświetlanego zdjęcia:
      1. Kliknij Wybierz obraz.
      2. Na liście dostępnych obrazów w oknie Wybierz obraz kliknij home-background.jpg.
      3. Kliknij Wybierz.
      4. Wyświetl podgląd obrazu i kliknij Wybierz.
    • W polu Kategorie wpisz Rozpocznij i naciśnij Enter.

    Pozostałe wartości pozostaw domyślne.

  5. Aby automatycznie wygenerować dokumentację referencyjną interfejsu API na podstawie snapshotu specyfikacji OpenAPI:
    1. Wybierz dokument OpenAPI.
    2. Kliknij Wybierz dokument.
    3. Kliknij kartę Moje specyfikacje (jeśli nie jest jeszcze wybrana).
    4. Na liście specyfikacji wybierz helloworld.
    5. Kliknij Wybierz.
  6. Aby zapisać szczegóły interfejsu API, kliknij Zapisz.

    Interfejs API Hello World z wszystkimi ustawionymi polami

Aby wyświetlić dokumentację API:

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

Publikowanie testowego interfejsu Target API za pomocą panelu Wypróbuj ten interfejs API

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