Publikowanie interfejsów API

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

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

Omówienie publikowania interfejsów API

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

1. Wybierz usługę API, którą chcesz opublikować w portalu.
2. Renderuj dokumentację interfejsu API na podstawie zrzutu dokumentu OpenAPI lub schematu GraphQL, aby umożliwić deweloperom aplikacji poznanie Twoich interfejsów API. Więcej informacji o migawkach znajdziesz w artykule Co to jest zrzut dysku?.

Co jest publikowane w portalu?

Gdy opublikujesz interfejs API, w portalu zostaną automatycznie wprowadzone te zmiany:

Dokumentacja API. Dostępność interfejsu zależy od tego, czy publikujesz przy użyciu dokumentu OpenAPI, czy schematu GraphQL. Zobacz:

• SmartDokumentacja (OpenAPI)
• Eksplorator GraphQL

Do strony z informacjami o interfejsach API zostanie dodany link do strony z informacjami o interfejsach API.

Strona interfejsów API (dołączona do przykładowego portalu) zawiera listę wszystkich interfejsów API opublikowanych w Twoim portalu (w kolejności alfabetycznej), wraz z linkami do dokumentacji referencyjnej odpowiednich interfejsów API, które zawierają więcej informacji. Opcjonalnie możesz dostosować te ustawienia:

• Obraz wyświetlany dla każdej karty interfejsu API
• Kategorie używane do tagowania interfejsów API w celu umożliwienia deweloperom odkrywania powiązanych interfejsów API na stronie interfejsów API

SmartDokumentacja (OpenAPI)

Gdy opublikujesz interfejs API przy użyciu dokumentu OpenAPI, dokumentacja interfejsu SmartDokumentacja API zostanie dodana do Twojego portalu.

Deweloperzy mogą zapoznać się z dokumentacją interfejsu SmartDokumentacja API i użyć panelu Wypróbuj ten interfejs API, aby utworzyć żądanie do interfejsu API i wyświetlić wyniki. Wypróbuj ten interfejs API, który działa z niezabezpieczonymi punktami końcowymi i zabezpieczonymi punktami końcowymi przy użyciu podstawowego, klucza interfejsu API lub uwierzytelniania OAuth, w zależności od metody zabezpieczeń zdefiniowanej w dokumencie OpenAPI. W przypadku protokołu OAuth obsługiwane są te przepływy: kod autoryzacji, hasło i dane logowania klienta.

Kliknij , aby rozwinąć panel Wypróbuj ten interfejs API. Rozwinięty panel umożliwia wyświetlanie wywołania curl i przykładowego kodu w różnych formatach, takich jak HTTP, Python czy Node.js, jak widać poniżej.

Eksplorator GraphQL

Gdy opublikujesz interfejs API przy użyciu schematu GraphQL, do portalu zostanie dodany eksplorator GraphQL. Eksplorator GraphQL to interaktywne środowisko do uruchamiania zapytań kierowanych na interfejs API. Eksplorator jest oparty na GraphiQL – referencyjnej implementacji IDE GraphQL opracowanej przez GraphQL Foundation.

Programiści mogą używać eksploratora GraphQL do przeglądania interaktywnej dokumentacji opartej na schematach, tworzenia i wykonywania zapytań, wyświetlania wyników zapytań oraz pobierania schematu. Aby zabezpieczyć dostęp do interfejsu API, deweloperzy mogą przekazywać nagłówki autoryzacji w panelu Nagłówki żądań.

Więcej informacji o GraphQL znajdziesz na graphql.org.

Co to jest zrzut ekranu?

Każdy dokument OpenAPI lub GraphQL służy jako źródło wiarygodnych danych przez cały cykl życia API. Ten sam dokument jest używany na każdym etapie cyklu życia interfejsu API – od programowania, przez publikowanie, po monitorowanie. Gdy zmodyfikujesz dokument, musisz wiedzieć, jak te zmiany wpłyną na działanie interfejsu API na innych etapach cyklu życia, co zostało opisane w sekcji Co się stanie, gdy zmodyfikuję dokument?.

Podczas publikowania interfejsu API tworzysz zrzut dokumentu OpenAPI lub GraphQL, aby renderować dokumentację referencyjną API. Ten zrzut reprezentuje konkretną wersję dokumentu. Jeśli zmodyfikujesz dokument, możesz zrobić jego kolejną kopię, aby odzwierciedlić ostatnie zmiany w dokumentacji referencyjnej interfejsu API.

Informacje o adresach URL wywołania zwrotnego

Jeśli Twoje aplikacje wymagają adresu URL wywołania zwrotnego, na przykład używając typu uwierzytelnienia kodu autoryzacji OAuth 2.0 (nazywanego często „trzyetapową autoryzacją OAuth”), możesz wymagać od deweloperów określenia adresu URL wywołania zwrotnego podczas rejestrowania aplikacji. Adres URL wywołania zwrotnego zazwyczaj określa adres URL aplikacji, która otrzymuje kod autoryzacji w imieniu aplikacji klienckiej. Więcej informacji znajdziesz w artykule o implementowaniu typu przyznania kodu autoryzacji.

Możesz określić, czy adres URL wywołania zwrotnego ma być wymagany podczas rejestracji aplikacji podczas dodawania interfejsu API do portalu. Możesz zmienić to ustawienie w każdej chwili zgodnie z opisem w artykule Zarządzanie adresem URL wywołania zwrotnego dla interfejsu API.

Podczas rejestrowania aplikacji deweloperzy muszą wpisać URL wywołania zwrotnego dla wszystkich interfejsów API, które go wymagają, zgodnie z opisem w artykule Rejestrowanie aplikacji.

Skonfiguruj serwer proxy interfejsu API, aby obsługiwać „Wypróbuj ten interfejs API”

Zanim opublikujesz swoje interfejsy API przy użyciu dokumentu OpenAPI, musisz skonfigurować serwer proxy interfejsu API, tak aby obsługiwał wysyłanie żądań w panelu Wypróbuj ten interfejs API w dokumentacji referencyjnej SmartDokumentacja API. Możesz to zrobić w następujący sposób:

• Dodaj obsługę CORS do serwerów proxy interfejsów API, aby wymuszać po stronie klienta żądania z innych domen
  

  CORS to standardowy mechanizm, który pozwala wywołaniom JavaScriptu XMLHttpRequest (XHR) wykonywanych na stronie internetowej wchodzić w interakcje z zasobami z domen innych niż źródłowe. CORS to powszechnie zaimplementowane rozwiązanie dotyczące „zasady tego samego pochodzenia” egzekwowane przez wszystkie przeglądarki.

• Jeśli korzystasz z uwierzytelniania podstawowego lub protokołu OAuth2, zaktualizuj konfigurację serwera proxy interfejsu API.

Tabela poniżej zawiera podsumowanie wymagań dotyczących konfiguracji serwera proxy interfejsu API w celu obsługi panelu Wypróbuj ten interfejs API w dokumentacji interfejsu SmartDokumentacja API na podstawie uprawnień dostępu do uwierzytelniania.

Dostęp do uwierzytelniania	Wymagania dotyczące konfiguracji zasad
Brak lub klucz interfejsu API	Dodaj obsługę CORS do serwera proxy interfejsu API. Dla wygody skorzystaj z przykładowego rozwiązania CORS z GitHuba lub wykonaj czynności opisane w artykule Dodawanie obsługi CORS do serwera proxy interfejsu API.
Podstawowe uwierzytelnianie	Wykonaj te czynności: Dodaj obsługę CORS do serwera proxy interfejsu API. Dla wygody skorzystaj z przykładowego rozwiązania CORS z GitHuba lub wykonaj czynności opisane w artykule Dodawanie obsługi CORS do serwera proxy interfejsu API. Upewnij się, że w zasadzie Add CORS AssignMessage nagłówek Access-Control-Allow-Headers zawiera atrybut authorization. Na przykład: <Header name="Access-Control-Allow-Headers"> origin, x-requested-with, accept, content-type, authorization </Header>
OAuth2	Dodaj obsługę CORS do serwera proxy interfejsu API. Dla wygody skorzystaj z przykładowego rozwiązania CORS z GitHuba lub wykonaj czynności opisane w artykule Dodawanie obsługi CORS do serwera proxy interfejsu API. Upewnij się, że w zasadzie Add CORS AssignMessage nagłówek Access-Control-Allow-Headers zawiera atrybut authorization. Na przykład: <Header name="Access-Control-Allow-Headers"> origin, x-requested-with, accept, content-type, authorization </Header> Popraw działanie niezgodne z RFC w zasadzie OAuth2. Dla wygody skorzystaj z przykładowego rozwiązania OAuth2 dostępnego na GitHubie lub wykonaj te czynności: Sprawdź, czy element <GrantType> w zasadzie OAuth2 ma wartość request.formparam.grant_type (parametr formularza). Więcej informacji znajdziesz w <GrantType>. Sprawdź, czy pole token_type w zasadzie OAuth2 ma wartość Bearer, a nie domyślną wartość BearerToken.

Odkryj katalog interfejsów API

Aby wyświetlić katalog interfejsów API:
1. Kliknij Publish > Portals (Opublikuj > Portale) i wybierz swój portal.
2. Na stronie głównej portalu kliknij Katalog interfejsów API.
Możesz też wybrać Katalog interfejsów API w menu portalu na górnym pasku nawigacyjnym.

Na karcie Interfejsy API w katalogu interfejsów API znajduje się lista interfejsów API, które zostały dodane do Twojego portalu.

Jak już wspomnieliśmy na poprzedniej ilustracji, karta Interfejsy API umożliwia:

• Wyświetl szczegóły interfejsów API dostępnych w Twoim portalu
• Dodawanie interfejsu API do portalu
• Aby zmodyfikować interfejs API w portalu, wykonaj co najmniej jedną z tych czynności:
  • Zarządzaj migawką dokumentu powiązanego z usługą API w celu aktualizacji dokumentacji API.
  • Publikowanie interfejsu API w portalu i cofanie jego publikacji
  • Zarządzanie widocznością interfejsu API w portalu:
  • Zarządzanie adresem URL wywołania zwrotnego dla interfejsu API
  • Zarządzanie obrazem karty interfejsu API
  • Tagowanie interfejsu API za pomocą kategorii
  • Edytowanie tytułu i opisu interfejsu API
• Usuwanie interfejsu API z portalu
• Zarządzanie kategoriami używanymi do wykrywania powiązanych interfejsów API
• Szybko identyfikuj specyfikacje, które są nieaktualne lub zostały usunięte ze sklepu z specyfikacjami
• Szybko zidentyfikuj „osierocone” interfejsy API, których powiązana usługa API została usunięta z Edge, i ponownie utwórz ją lub usuń z portalu.

Dodawanie interfejsu API do portalu

Aby dodać interfejs API do portalu:

1. Dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.

3. Kliknij +.

   Pojawi się okno Dodaj produkt API do katalogu.

4. Wybierz usługę API, którą chcesz dodać do portalu.

5. Kliknij Dalej.
   Pojawi się strona ze szczegółami interfejsu API.

6. Skonfiguruj treść dokumentacji API i jej widoczność w portalu:

   Field	Opis
   Opublikowano	Wybierz Opublikowano, aby opublikować interfejs API w swoim portalu. Jeśli nie chcesz jeszcze publikować interfejsu API, odznacz pole wyboru. Możesz zmienić to ustawienie później, zgodnie z opisem w artykule Publikowanie i cofanie publikacji interfejsu API w portalu.
   Wyświetl tytuł	Zaktualizuj tytuł interfejsu API wyświetlany w katalogu. Domyślnie używana jest nazwa usługi API. Później możesz zmienić wyświetlany tytuł, postępując zgodnie z instrukcjami w sekcji Edytowanie wyświetlanego tytułu i opisu.
   Wyświetlany tekst reklamy	Zaktualizuj opis interfejsu API wyświetlany w katalogu. Domyślnie używany jest opis produktu w ramach interfejsu API. Później możesz zmienić wyświetlany opis, zgodnie z instrukcjami w sekcji Edytowanie wyświetlanego tytułu i opisu.
   Wymagaj od programistów określenia adresu URL wywołania zwrotnego	Włącz tę opcję, jeśli chcesz, aby deweloperzy aplikacji określali adres URL wywołania zwrotnego. Adres URL wywołania zwrotnego możesz dodać lub zaktualizować później zgodnie z opisem w sekcji Zarządzanie adresem URL wywołania zwrotnego dla interfejsu API.
   Dokumentacja interfejsu API	Aby użyć dokumentu OpenAPI: Wybierz Dokument OpenAPI. Kliknij Wybierz dokument. Wykonaj jedną z tych czynności: Kliknij kartę My Specifications (Moje specyfikacje) i wybierz specyfikację z magazynu specyfikacji. Kliknij kartę Prześlij plik i prześlij plik. Kliknij kartę Importuj z adresu URL i zaimportuj specyfikację z adresu URL. Kliknij Wybierz. Aby użyć schematu GraphQL: Wybierz SchemaphQL Schema (Schemat wykresu QL). Kliknij Wybierz dokument. Przejdź do schematu GraphQL i wybierz go. Kliknij Wybierz. Możesz też wybrać Brak dokumentacji i dodać ją później po dodaniu interfejsu API zgodnie z opisem w sekcji Zarządzanie migawką dokumentu.
   Widoczność interfejsu API	Jeśli nie zarejestrujesz się w wersji beta funkcji zarządzania odbiorcami, wybierz jedną z tych opcji: Użytkownicy anonimowi, aby umożliwić wszystkim użytkownikom wyświetlanie interfejsu API. Zarejestrowani użytkownicy, aby zezwolić na wyświetlanie interfejsu API tylko zarejestrowanych użytkownikom. Jeśli zarejestrujesz się w wersji beta funkcji zarządzania odbiorcami, wybierz jedną z tych opcji: Publiczny (widoczny dla każdego), aby umożliwić wszystkim użytkownikom wyświetlanie interfejsu API. Uwierzytelnieni użytkownicy, aby zezwolić na wyświetlanie interfejsu API tylko zarejestrowanym użytkownikom. Wybrane grupy odbiorców, aby wskazać konkretne grupy odbiorców, które mają mieć dostęp do interfejsu API. Widocznością list odbiorców możesz później zarządzać zgodnie z opisem w sekcji Zarządzanie widocznością interfejsu API w portalu.
   Wyświetlany obrazy	Aby wyświetlić obraz na karcie interfejsu API na stronie interfejsów API, kliknij Wybierz obraz. W oknie Wybierz obraz wybierz istniejący obraz, prześlij nowy lub podaj adres URL obrazu zewnętrznego i kliknij Wybierz. Wyświetl podgląd miniatury interfejsu API i kliknij Wybierz. Obraz możesz dodać później, zgodnie z opisem w sekcji Zarządzanie obrazem karty interfejsu API.
   Kategorie	Dodaj kategorie, do których zostanie otagowany interfejs API, aby umożliwić deweloperom aplikacji wykrywanie powiązanych interfejsów API na stronie interfejsów API. Aby zidentyfikować kategorię: Wybierz kategorię z listy. Aby dodać nową kategorię, wpisz jej nazwę i naciśnij Enter. Nowa kategoria zostanie dodana do strony Kategorie i będzie dostępna podczas dodawania lub edytowania innych interfejsów API.

7. Kliknij Zapisz.

Zarządzanie migawką dokumentu

Po opublikowaniu interfejsu API możesz w każdej chwili wykonać nowy zrzut dokumentu OpenAPI lub GraphQL, aby zaktualizować opublikowaną w portalu dokumentację API.

Aby zarządzać migawką dokumentu:

1. Dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Sprawdź stan zrzutu. Jeśli jest ona nieaktualna, pojawi się ten komunikat:
   
5. Kliknij .
6. Wykonaj jedną z tych czynności:
   • Aby odświeżyć zrzut nieaktualnego dokumentu OpenAPI, kliknij Odśwież zrzut.
   • Aby zmienić dokument, który służy do generowania dokumentacji interfejsu API, w sekcji dokumentacji interfejsu API kliknij Select Document (Wybierz dokument) i wybierz nowy dokument.
7. Kliknij Zapisz.

Dokumentacja API jest renderowana z dokumentu i dodawana do strony z dokumentacją API. Stan zrzutu jest zmieniany na aktualny:

Publikowanie i cofanie publikacji interfejsu API w portalu

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

1. Dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Kliknij .
5. W sekcji Szczegóły interfejsu API zaznacz lub odznacz opcję Opublikowano (znajduje się w katalogu), aby odpowiednio opublikować interfejs API w portalu lub cofnąć jego publikację.
6. Kliknij Zapisz.

Zarządzanie widocznością interfejsu API w portalu

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

• Publiczny (widoczny dla każdego)
• Uwierzytelnieni użytkownicy
• Wybrani odbiorcy (jeśli zarejestrujesz się w wersji beta funkcji zarządzania odbiorcami)

Aby zarządzać widocznością interfejsu API w portalu:

1. Dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Kliknij .
5. W sekcji Widoczność interfejsu API wybierz jedną z tych opcji:

6. Wybierz ustawienie widoczności. Jeśli zarejestrujesz się w wersji beta funkcji odbiorców, wybierz jedną z tych opcji:

   • Publiczna (widoczna dla każdego), aby wszyscy użytkownicy mogli wyświetlać stronę.
   • Uwierzytelnieni użytkownicy, aby zezwolić na wyświetlanie strony tylko zarejestrowanym użytkownikom.
   • Wybrani odbiorcy, aby wskazać konkretnych odbiorców, którzy będą mogli wyświetlać stronę. Zobacz Zarządzanie odbiorcami w portalu.
   W przeciwnym razie wybierz jedną z tych opcji:
   • Anonimowi użytkownicy, aby zezwolić wszystkim użytkownikom na wyświetlanie strony.
   • Zarejestrowani użytkownicy, aby zezwolić na wyświetlanie strony tylko zarejestrowanych użytkownikom.

7. Kliknij Prześlij.

Zarządzanie adresem URL wywołania zwrotnego dla interfejsu API

Zarządzanie adresem URL wywołania zwrotnego dla interfejsu API. Zobacz Informacje o adresach URL wywołań zwrotnych.

Aby zarządzać adresem URL wywołania zwrotnego dla interfejsu API:

1. Dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Kliknij .
5. W sekcji Szczegóły interfejsu API zaznacz lub odznacz opcję Opublikowano (znajduje się w katalogu), aby odpowiednio opublikować interfejs API w portalu lub cofnąć jego publikację.
6. Kliknij Zapisz.

Zarządzanie obrazem karty interfejsu API

Aby zarządzać obrazem, który wyświetla się z kartą API na stronie interfejsów API, dodaj lub zmień bieżący obraz.

Aby zarządzać obrazem karty interfejsu API:

1. Dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Kliknij .

5. W sekcji Szczegóły interfejsu API:

   • Kliknij Wybierz obraz, aby wybrać lub przesłać obraz, jeśli nie jest on obecnie wybrany.
   • Kliknij Zmień obraz, aby wybrać lub przesłać inny obraz.
   • Kliknij x na obrazie, aby go usunąć.

6. Kliknij Zapisz.

Tagowanie interfejsu API za pomocą kategorii

Taguj interfejs API za pomocą kategorii na jeden z tych sposobów:

• Zarządzaj kategoriami, do których interfejs API jest oznaczany podczas edytowania interfejsu API w sposób opisany poniżej.
• Podczas edytowania kategorii możesz zarządzać interfejsami API otagowanymi w kategorii.

Aby oznaczyć tagiem interfejs API w kategoriach podczas jego edytowania:

1. Dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Kliknij .
5. Kliknij w polu Kategorie i wykonaj jedną z tych czynności:
   • Wybierz kategorię z listy.
   • Aby dodać nową kategorię, wpisz jej nazwę i naciśnij Enter. Nowa kategoria zostanie dodana do strony Kategorie i będzie dostępna podczas dodawania lub edytowania innych interfejsów API.
6. Powtórz te czynności, aby dodać tagi do interfejsu API w większej liczbie kategorii.
7. Kliknij Zapisz.

Edytuj wyświetlany tytuł i opis

Aby edytować wyświetlany tytuł i opis:

1. Dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Kliknij .
5. Zmodyfikuj pola Wyświetlany tytuł i Opis wyświetlany zgodnie z wymaganiami.
6. Kliknij Zapisz.

Usuwanie interfejsu API z portalu

Aby usunąć interfejs API z portalu:

1. Dostęp do katalogu interfejsów API.
2. Wybierz Interfejsy API, jeśli nie zostały jeszcze wybrane.
3. Najedź kursorem na interfejs API na liście, aby wyświetlić menu czynności.
4. Kliknij .

Zarządzaj kategoriami używanymi do wykrywania powiązanych interfejsów API

Dodaj tagi do interfejsu API przy użyciu kategorii, aby umożliwić deweloperom aplikacji odkrywanie powiązanych interfejsów API na stronie interfejsów API w aktywnym portalu. Dodawaj kategorie i zarządzaj nimi w sposób opisany w sekcjach poniżej.

Poznawanie strony Kategorie

Aby wyświetlić stronę Kategorie:

1. Kliknij Publish > Portals (Opublikuj > Portale) i wybierz swój portal.
2. Na stronie głównej portalu kliknij Katalog interfejsów API.

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

3. Kliknij kartę Kategorie.

Na karcie Kategorie w katalogu interfejsów API znajduje się lista kategorii zdefiniowanych dla portalu.

Jak już wspomnieliśmy na poprzednim ilustracji, strona interfejsów API umożliwia:

• Wyświetl kategorie i interfejsy API, do których zostały oznaczone tagami
• Dodaj kategorię
• Edytowanie kategorii
• Usuwanie kategorii
• Zarządzaj interfejsami API opublikowanymi w portalu. Zobacz Przeglądanie katalogu interfejsów API

Dodawanie kategorii

Dodaj kategorię na jeden z tych sposobów:

• Wpisz nazwę kategorii podczas dodawania interfejsu API do portalu.
• Dodaj kategorię ręcznie, tak jak opisano poniżej

Nowa kategoria zostanie dodana do strony Kategorie i będzie dostępna podczas dodawania lub edytowania innych interfejsów API.

Aby ręcznie dodać kategorię:

1. Otwórz stronę Kategorie.
2. Kliknij +.
3. Wpisz nazwę nowej kategorii.
4. Opcjonalnie wybierz co najmniej 1 interfejs API, aby otagować kategorię.
5. Kliknij Utwórz.

Edytowanie kategorii

Aby edytować kategorię:

1. Otwórz stronę Kategorie.
2. Kliknij .
3. Zmień nazwę kategorii.
4. Dodaj lub usuń tagi interfejsu API.
5. Kliknij Zapisz.

Usuwanie kategorii

Jeśli usuniesz kategorię, usunięte zostaną również wszystkie przypisane do niej tagi interfejsu API.

Aby usunąć kategorię:

1. Otwórz stronę Kategorie.
2. Umieść kursor nad kategorią, którą chcesz edytować, aby wyświetlić menu czynności.
3. Kliknij .
4. Zmień nazwę kategorii.
5. Dodawanie i usuwanie interfejsów API.
6. Kliknij Zapisz.

Rozwiązywanie problemów z opublikowanymi interfejsami API

Poniższe sekcje zawierają informacje pomocne w rozwiązywaniu konkretnych problemów z opublikowanymi interfejsami API.

Błąd: nie udało się pobrać błędu, który został zwrócony podczas korzystania z tego interfejsu API

Jeśli podczas korzystania z tego interfejsu API wystąpi błąd TypeError: Failed to fetch, weź pod uwagę te możliwe przyczyny i rozwiązania:

• W przypadku błędów związanych z treścią mieszaną błąd może być spowodowany przez znany problem z elementami interfejsu. Jednym z rozwiązań tymczasowych jest zapewnienie, że HTTPS przed HTTP jest określony w definicji schemes w dokumencie OpenAPI. Na przykład:

  schemes:
     - https
     - http
  

• W przypadku błędów związanych z ograniczeniem udostępniania zasobów między serwerami (CORS) sprawdź, czy serwery proxy interfejsu API obsługują CORS. CORS to standardowy mechanizm, który umożliwia obsługę żądań z innych domen po stronie klienta. Więcej informacji znajdziesz w artykule Konfigurowanie serwera proxy interfejsu API w celu zapewnienia obsługi tego interfejsu API.

Błąd: nagłówek „Access-Control-Allow-Origin” zawiera wiele wartości „*, *”, ale dozwolony jest tylko jeden

Podczas korzystania z tego interfejsu API możesz zobaczyć ten komunikat o błędzie, jeśli nagłówek Access-Control-Allow-Origin już istnieje:

The 'Access-Control-Allow-Origin' header contains multiple values '*, *', but only one is allowed.

Aby naprawić ten błąd, zmodyfikuj zasadę AssignMessage tak, aby do ustawiania nagłówków CORS zamiast <Add> używać <Set>, jak pokazano we fragmencie poniżej. Więcej informacji znajdziesz w odpowiednim artykule społeczności.

<AssignMessage async="false" continueOnError="false" enabled="true" name="add-cors">
    <DisplayName>Add CORS</DisplayName>
    <FaultRules/>
    <Properties/>
    <Set>
        <Headers>
            <Header name="Access-Control-Allow-Origin">{request.header.origin}</Header>
            <Header name="Access-Control-Allow-Headers">origin, x-requested-with, accept, content-type, authorization</Header>
            <Header name="Access-Control-Max-Age">3628800</Header>
            <Header name="Access-Control-Allow-Methods">GET, PUT, POST, DELETE</Header>
        </Headers>
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

Błąd: pole nagłówka żądania jest niedozwolone

Jeśli podczas korzystania z tego interfejsu API wystąpi błąd Request header field not allowed (podobny do przykładu poniżej), może być konieczna aktualizacja nagłówków obsługiwanych przez zasadę CORS. Na przykład:

Access to XMLHttpRequest ... has been blocked by CORS policy: Request header field
content-type is not allowed by Access-Control-Allow-Headers in preflight response

W tym przykładzie musisz dodać nagłówek content-type do sekcji Access-Control-Allow-Headers w zasadzie CORS AssignMessage zgodnie z opisem w sekcji Dołączanie zasady dodawania CORS do nowego serwera proxy interfejsu API.

Błąd: odmowa dostępu podczas wywoływania serwera proxy interfejsu API za pomocą protokołu OAuth2

Zasada OAuthV2 Apigee zwraca odpowiedź tokena zawierającą określone właściwości niezgodne z RFC. Na przykład zasada zwraca token o wartości BearerToken zamiast oczekiwanej wartości Bearer zgodnej ze standardem RFC. Ta nieprawidłowa odpowiedź token_type może spowodować błąd Access denied podczas korzystania z tego interfejsu API.

Aby rozwiązać ten problem, możesz utworzyć zasadę JavaScript lub AssignMessage w celu przekształcenia danych wyjściowych zasady na zgodny format. Więcej informacji znajdziesz w sekcji na temat działania niezgodnego ze standardem RFC.