Opublikuj swoje interfejsy API (wersja oryginalna)

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Opublikuj w portalu interfejsy API, aby udostępnić je deweloperom aplikacji w sposób opisany w sekcjach poniżej.

Omówienie publikowania przez interfejs API

Publikowanie interfejsów API w portalu składa się z 2 etapów:

1. Wybierz usługę API, którą chcesz opublikować w portalu.
2. Automatycznie wygeneruj dokumentację referencyjną interfejsów API na podstawie zrzutu specyfikacji OpenAPI, aby deweloperzy aplikacji mogli poznać Twoje interfejsy API. (Więcej informacji o zrzutach znajdziesz w artykule Czym jest zrzut specyfikacji OpenAPI?

Gdy opublikujesz w portalu interfejs API, automatycznie wprowadzane są w nim zmiany:

• Strona z informacjami o interfejsie API zostanie dodana do portalu
  Na stronie Materiały referencyjne interfejsu API znajdziesz dokumentację referencyjnej interfejsu API wygenerowaną automatycznie na podstawie zrzutu specyfikacji OpenAPI. Deweloperzy mogą zapoznać się z dokumentacją interfejsu API i kliknąć Wypróbuj, aby wysłać żądanie do interfejsu API i wyświetlić dane wyjściowe.

  Uwaga: nie możesz bezpośrednio edytować zawartości tej strony. nie pojawi się na liście stron w portalu.

  

• Link do strony z informacjami o interfejsach API zostaje dodany do strony interfejsów API
  Strona interfejsów API (dołączona do przykładowego portalu) zawiera listę wszystkich interfejsów API opublikowanych w portalu oraz linki do dokumentacji referencyjnej dotyczącej tych interfejsów API, na których można uzyskać więcej informacji.

  Uwaga: nie możesz bezpośrednio edytować zawartości tej strony. nie pojawi się na liście stron w portalu.

  

Co to jest zrzut specyfikacji OpenAPI?

Każda specyfikacja OpenAPI służy jako źródło danych w całym cyklu życia interfejsu API. Ta sama specyfikacja jest używana na każdym etapie cyklu życia interfejsu API – od programowania przez publikowanie po monitorowanie. Gdy modyfikujesz specyfikację, musisz uwzględniać wpływ tych zmian na interfejs API na innych etapach cyklu życia, zgodnie z opisem w sekcji Co się stanie, jeśli zmodyfikuję specyfikację?.

Po opublikowaniu interfejsu API możesz wykonać zrzut specyfikacji OpenAPI, aby wygenerować dokumentację API. Zrzut zawiera konkretną wersję specyfikacji w magazynie specyfikacji. Jeśli zmienisz specyfikację OpenAPI za pomocą edytora specyfikacji, możesz zrobić kolejny zrzut specyfikacji, aby odzwierciedlić najnowsze zmiany w dokumentacji referencyjnej interfejsu API.

Dodawanie obsługi CORS do serwerów proxy interfejsu API

Zanim opublikujesz interfejsy API, musisz dodać obsługę CORS do swoich serwerów proxy API, aby obsługiwać żądania z innych domen po stronie klienta.

CORS (międzydomenowe udostępnianie zasobów) to standardowy mechanizm, który umożliwia wywoływaniu JavaScriptu XMLHttpRequest (XHR) wykonywane na stronie internetowej interakcje z zasobami z domen innych niż domeny. CORS to powszechnie stosowane rozwiązanie zasady dotyczące tego samego pochodzenia, które jest egzekwowane przez wszystkie przeglądarki. Jeśli na przykład wyślesz wywołanie XHR do interfejsu Twitter API z poziomu kodu JavaScript wykonywanego w przeglądarce, wywołanie się nie powiedzie. Dzieje się tak, ponieważ domena wyświetlająca stronę w przeglądarce różni się od domeny obsługującej interfejs Twitter API. CORS stanowi rozwiązanie tego problemu, umożliwiając serwerom wyrażenie zgody , jeśli chcą udostępniać zasoby między domenami.

Informacje o dodawaniu obsługi CORS do serwerów proxy interfejsu API przed opublikowaniem interfejsów API znajdziesz w sekcji Dodawanie obsługi CORS do serwera proxy interfejsu API.

Uwaga: większość nowoczesnych przeglądarek wymusza stosowanie CORS. Zapoznaj się z pełną listą obsługiwanych przeglądarek. Szczegółowy opis CORS znajdziesz w rekomendacji W3C udostępniania zasobów z różnych domen.

Poznaj stronę interfejsów API

Aby uzyskać dostęp do strony interfejsów API:

1. Kliknij Opublikuj > Portale i wybierz swój portal.
2. Na stronie głównej portalu kliknij APIs (Interfejsy API).

Możesz też wybrać Interfejsy API w menu portalu na górnym pasku nawigacyjnym.

Pojawi się lista interfejsów API.

Jak zaznaczyliśmy na poprzednim rysunku, strona interfejsów API umożliwia:

• Wyświetl szczegóły interfejsów API dostępnych w portalu
• Dodawanie interfejsu API do portalu
• Zrób zrzut specyfikacji OpenAPI powiązanej z usługą API, aby zaktualizować dokumentację API.
• Publikowanie lub cofanie publikacji interfejsu API w portalu
• Zarządzanie odbiorcami interfejsu API w portalu
• Edytować powiązaną specyfikację (przeczytaj artykuł Tworzenie specyfikacji za pomocą edytora specyfikacji).
• Usuwanie interfejsu API z portalu
• Szybko rozpoznawaj „osierocone” Interfejsy API, których powiązana usługa API została usunięta z Edge i ponownie utwórz tę usługę lub usuń interfejs API z portalu

Dodaj interfejs API do portalu

Uwaga: do portalu możesz dodać maksymalnie 100 interfejsów API.

Aby dodać interfejs API do portalu:

1. Kliknij Opublikuj > Portale i wybierz swój portal.
2. Na stronie głównej portalu kliknij APIs (Interfejsy API).
   Możesz też wybrać Interfejsy API w menu portalu na górnym pasku nawigacyjnym.
3. Kliknij + API.
   Pojawi się okno Dodaj usługę API do portalu.

4. Na karcie Usługa API w oknie wybierz usługę API, którą chcesz dodać do portalu.
   

5. Kliknij Dalej.

6. Wybierz źródło, którego chcesz używać na potrzeby zrzutu.
   Jeśli serwer proxy interfejsu API został utworzony w usłudze API za pomocą specyfikacji OpenAPI, wybierz specyfikację z listy.
   

   Możesz też wybrać:

   • Brak specyfikacji i dodaj ją później po opublikowaniu interfejsu API, jak opisano w sekcji Wykonywanie zrzutu specyfikacji.
   • Wybierz inną specyfikację, aby wybrać, lub prześlij nową specyfikację.

7. Zaznacz pole wyboru Opublikowano, aby opublikować interfejs API w portalu. Jeśli nie chcesz jeszcze opublikować interfejsu API, odznacz Opublikowano.
   To ustawienie możesz później zmienić zgodnie z opisem w artykule Publikowanie i cofanie publikacji interfejsu API w portalu.

8. W sekcji Odbiorcy wybierz jedną z tych opcji, aby zarządzać listą odbiorców interfejsu API, zezwalając na dostęp:

   • Użytkownicy anonimowi, aby umożliwić wyświetlanie strony wszystkim użytkownikom.
   • Zarejestrowani użytkownicy, aby umożliwić wyświetlanie strony tylko zarejestrowanym użytkownikom.

   To ustawienie możesz później zmienić zgodnie z opisem w artykule Zarządzanie odbiorcami w przypadku interfejsu API w portalu.

9. Kliknij Zakończ.

Przegląd specyfikacji

Po opublikowaniu interfejsu API możesz w dowolnym momencie wykonać nowe zdjęcie specyfikacji OpenAPI, aby zaktualizować dokumentację referencyjnej interfejsu API opublikowaną w Twoim portalu.

Aby zrobić zrzut specyfikacji OpenAPI:

1. Kliknij Opublikuj > Portale i wybierz swój portal.
2. Na stronie głównej portalu kliknij APIs (Interfejsy API).
   Możesz też wybrać Interfejsy API w menu portalu na górnym pasku nawigacyjnym.
3. Najedź kursorem na interfejs API, dla którego chcesz wykonać zrzut, aby wyświetlić działania.

4. Kliknij .

   Uwaga: jeśli zrzut jest aktualny zgodnie z wybraną specyfikacją źródłową, wyświetli się komunikat.

5. Wybierz istniejącą specyfikację z listy Źródło zrzutu lub kliknij Wybierz inną specyfikację, aby wybrać lub przesłać nową specyfikację, która będzie służyć do generowania dokumentacji interfejsu API. Możesz też wybrać Brak specyfikacji, aby usunąć bieżącą specyfikację.

6. Kliknij Zaktualizuj zrzut (lub Usuń zrzut, jeśli wybierzesz brak specyfikacji.

Dokumentacja referencyjna API jest generowana na podstawie specyfikacji i dodawana do strony z informacjami o interfejsie API.

Publikowanie lub cofanie publikacji interfejsu API w portalu

Aby opublikować interfejs API w portalu lub cofnąć jego publikację:

1. Kliknij Opublikuj > Portale i wybierz swój portal.
2. Na stronie głównej portalu kliknij APIs (Interfejsy API).
   Możesz też wybrać Interfejsy API w menu portalu na górnym pasku nawigacyjnym.
3. Najedź kursorem na interfejs API, który chcesz opublikować lub cofnąć publikację.
4. Kliknij .
5. Zaznacz pole wyboru Włączono, aby opublikować interfejs API w portalu. Odznacz Włączono, aby cofnąć publikację interfejsu API.
6. Kliknij Zapisz.

Zarządzanie odbiorcami interfejsu API w portalu

Zarządzaj odbiorcami interfejsu API w portalu, zezwalając na dostęp do:

• Wszyscy użytkownicy
• Tylko zarejestrowani użytkownicy

Aby zarządzać odbiorcami interfejsu API w portalu:

1. Kliknij Opublikuj > Portale i wybierz swój portal.
2. Na stronie głównej portalu kliknij APIs (Interfejsy API).
   Możesz też wybrać Interfejsy API w menu portalu na górnym pasku nawigacyjnym.
3. Najedź kursorem na interfejs API, w przypadku którego chcesz zarządzać listą odbiorców, aby wyświetlić działania.
4. Kliknij .
5. W sekcji Odbiorcy wybierz jedną z tych opcji:
   • Użytkownicy anonimowi, aby umożliwić wszystkim użytkownikom wyświetlanie usługi API.
   • Zarejestrowani użytkownicy, aby umożliwić wyświetlanie usługi API tylko zarejestrowanym użytkownikom.
6. Kliknij Zapisz.

Usuwanie interfejsu API z portalu

Aby usunąć interfejs API z portalu:

1. Kliknij Opublikuj > Portale i wybierz swój portal.
2. Na stronie głównej portalu kliknij APIs (Interfejsy API).
   Możesz też wybrać Interfejsy API w menu portalu na górnym pasku nawigacyjnym.
3. Aby wyświetlić menu czynności, najedź kursorem na interfejs API na liście.
4. Kliknij .

Rozwiązywanie problemów z opublikowanymi interfejsami API

Jeśli w przypadku korzystania z funkcji Wypróbuj i pojawi się błąd TypeError: Failed to fetch, rozważ następujące możliwe przyczyny i rozwiązania tych problemów:

• W przypadku błędów dotyczących treści mieszanych może on być spowodowany przez znany problem z interfejsem Swagger-UI. Jednym z możliwych rozwiązań jest określenie protokołu HTTPS przed HTTP w definicji schemes w specyfikacji OpenAPI. Na przykład:

   schemes:
     - https
     - http
  

• W przypadku błędów ograniczeń CORS (udostępnianie zasobów między domenami) sprawdź, czy Twoje serwery proxy interfejsu API obsługują ten mechanizm. CORS to standardowy mechanizm, który obsługuje żądania z innych domen po stronie klienta. Zobacz Dodawanie obsługi CORS dla serwera proxy interfejsu API. Sprawdź, czy CORS jest włączone również w przeglądarce.