Publikowanie interfejsów API

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

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

Omówienie publikowania interfejsu 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. Dokumentacja interfejsu API renderowania na podstawie zrzutu dokumentu OpenAPI lub schematu GraphQL, dzięki której deweloperzy aplikacji mogą poznać interfejsy 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 automatycznie wprowadzane są te aktualizacje:

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

• SmartDokumenty (OpenAPI)
• Eksplorator Wykresów

Do strony z interfejsami API został 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 (uporządkowaną alfabetycznie) wraz z linkami do dokumentacji referencyjnej odpowiednich interfejsów API, w których można znaleźć 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, które umożliwiają programistom odkrywanie powiązanych interfejsów API na stronie interfejsów API

Inteligentne Dokumenty (OpenAPI)

Gdy publikujesz interfejs API przy użyciu dokumentu OpenAPI, do Twojego portalu jest dodawana dokumentacja interfejsu SmartDoc API.

Deweloperzy mogą zapoznać się z dokumentacją interfejsu API SmartDoc oraz skorzystać z 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 lub zabezpieczonymi punktami końcowymi korzystającymi z podstawowego uwierzytelniania, 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ładów kodu w różnych formatach, takich jak HTTP, Python czy Node.js, jak pokazano poniżej.

Eksplorator GraphQL

Gdy publikujesz interfejs API przy użyciu schematu GraphQL, do portalu jest dodawany eksplorator GraphQL. Eksplorator GraphQL to interaktywna usługa do uruchamiania zapytań w interfejsie API. Eksplorator wykorzystuje GraphiQL – referencyjną implementację IDE GraphQL opracowanej przez GraphQL Foundation.

Programiści mogą używać eksploratora GraphQL do przeglądania interaktywnej dokumentacji opartej na schematach, tworzenia i uruchamiania zapytań, wyświetlania ich wyników 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?

Każdy dokument OpenAPI lub GraphQL służy jako źródło wiarygodnych danych przez cały cykl życia interfejsu 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 wziąć pod uwagę wpływ tych zmian na interfejs API na innych etapach cyklu życia. Więcej informacji znajdziesz 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 przedstawia konkretną wersję dokumentu. Jeśli zmodyfikujesz dokument, możesz zrobić jego nową kopię zapasową, aby odzwierciedlić najnowsze zmiany w dokumentacji referencyjnej interfejsu API.

Adresy URL wywołań zwrotnych

Jeśli Twoje aplikacje wymagają adresu URL wywołania zwrotnego – na przykład w przypadku korzystania z typu uwierzytelnienia kodu autoryzacji OAuth 2.0 (zwanego 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 zwykle określa adres URL aplikacji, która otrzymuje kod autoryzacji w imieniu aplikacji klienckiej. Więcej informacji znajdziesz w sekcji Wdrażanie typu uwierzytelnienia 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 sekcji Zarządzanie adresem URL wywołania zwrotnego dla interfejsu API.

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

Skonfiguruj serwer proxy interfejsu API do obsługi opcji „Wypróbuj ten interfejs API”

Zanim opublikujesz interfejsy API przy użyciu dokumentu OpenAPI, musisz skonfigurować serwer proxy interfejsu API pod kątem obsługi żądań w panelu Wypróbuj ten interfejs API w dokumentacji referencyjnej interfejsu SmartDocuments API w następujący sposób:

• Dodaj obsługę CORS do serwerów proxy interfejsu API, aby egzekwować żądania między domenami po stronie klienta

  CORS to standardowy mechanizm umożliwiający wywołanie kodu XMLHttpRequest (XHR) wykonywanego na stronie internetowej na interakcję z zasobami z domen innych niż źródłowe. CORS to powszechnie zaimplementowane rozwiązanie „zasad dotyczących 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 przypadku panelu Wypróbuj ten interfejs API w dokumentacji referencyjnej interfejsu SmartDocuments 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 sekcji 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 sekcji Dodawanie obsługi CORS do serwera proxy interfejsu API. Upewnij się, że nagłówek Access-Control-Allow-Headers zawiera atrybut authorization w zasadzie Add CORS AssignMessage. 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 sekcji Dodawanie obsługi CORS do serwera proxy interfejsu API. Upewnij się, że nagłówek Access-Control-Allow-Headers zawiera atrybut authorization w zasadzie Add CORS AssignMessage. 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 zasadach OAuth2. Dla wygody skorzystaj z przykładowego rozwiązania OAuth2 z GitHuba lub wykonaj te czynności: Sprawdź, czy element <GrantType> w zasadzie OAuth2 jest ustawiony na request.formparam.grant_type (parametr formularza). Więcej informacji znajdziesz w <GrantType>. Upewnij się, że token_type w zasadzie OAuth2 ma wartość Bearer, a nie domyślną wartość BearerToken.

Przeglądaj katalog interfejsów API

Aby wyświetlić katalog interfejsów API: 1. Kliknij 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 poprzednim ilustracji, karta Interfejsy API umożliwia:

• Wyświetl szczegóły interfejsów API dostępnych w Twoim portalu
• Dodawanie interfejsu API do portalu
• Aby edytować 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
  • Dodawanie tagów do 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 ze specyfikacjami
• Szybko znajdź „osierocone” interfejsy API, których powiązana usługa API została usunięta z Edge, i utwórz ją ponownie lub usuń ten interfejs z portalu.

Dodaj do portalu interfejs API

Aby dodać do portalu interfejs API:

1. uzyskać 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 referencyjnej interfejsu API oraz jej widoczność w portalu:

   Pole	Opis
   Opublikowano	Wybierz Publish (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 wycofywanie interfejsu API w portalu.
   Wyświetl tytuł	Zaktualizuj tytuł interfejsu API wyświetlany w katalogu. Domyślnie używana jest nazwa usługi interfejsu API. Wyświetlany tytuł możesz później zmienić zgodnie z opisem w sekcji Edytowanie wyświetlanego tytułu i opisu.
   Wyświetlany opis	Zaktualizuj opis interfejsu API, który jest widoczny w katalogu. Domyślnie używany jest opis produktu z interfejsu API. Wyświetlany opis możesz później zmienić 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 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 konfigurację ze 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 Select Document (Wybierz dokument). Przejdź do schematu GraphQL i wybierz go. Kliknij Wybierz. Możesz też wybrać opcję 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 zezwolić wszystkim użytkownikom na wyświetlanie interfejsu API. Zarejestrowani użytkownicy, aby zezwolić na wyświetlanie interfejsu API tylko zarejestrowanym użytkownikom. Jeśli zarejestrujesz się w wersji beta funkcji zarządzania odbiorcami, wybierz jedną z tych opcji: Publiczny (widoczny dla wszystkich), aby zezwolić wszystkim użytkownikom na wyświetlanie interfejsu API. Uwierzytelnieni użytkownicy, aby zezwolić na wyświetlanie interfejsu API tylko zarejestrowanym użytkownikom. Wybrani odbiorcy, aby wskazać konkretne grupy odbiorców, które mają mieć dostęp do interfejsu API. Widocznością 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 obraz 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. Jeśli określisz obraz z zewnętrznym adresem URL, obraz nie zostanie przesłany do Twoich zasobów. Dodatkowo wczytanie obrazu w zintegrowanym portalu będzie uzależnione od jego dostępności, która może być zablokowana lub ograniczona przez zasady bezpieczeństwa treści.
   Kategorie	Dodaj kategorie, do których zostanie otagowany interfejs API, aby umożliwić deweloperom aplikacji odkrywanie 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 w każdej chwili możesz wykonać nowy zrzut dokumentu OpenAPI lub GraphQL, aby zaktualizować opublikowaną w portalu dokumentację API.

Aby zarządzać migawką dokumentu:

1. uzyskać 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ć nieaktualne podsumowanie dokumentu OpenAPI, kliknij Odśwież zrzut.
   • Aby zmienić dokument, który służy do generowania dokumentacji interfejsu API, w sekcji Dokumentacja 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 informacjami o interfejsie API. Stan zrzutu dysku jest zmieniany na obecny:

Publikowanie i cofanie publikacji interfejsu API w portalu

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

1. uzyskać 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 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 wszystkich)
• Uwierzytelnieni użytkownicy
• Wybrani odbiorcy (jeśli korzystasz z funkcji zarządzania odbiorcami w wersji beta)

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

1. uzyskać 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 korzystasz z wersji beta funkcji odbiorców, wybierz jedną z tych opcji:

   • Publiczna (widoczna dla każdego), aby zezwolić wszystkim użytkownikom na wyświetlanie strony.
   • Uwierzytelnieni użytkownicy, aby zezwolić na wyświetlanie strony tylko zarejestrowanym użytkownikom.
   • Wybrani odbiorcy, aby wskazać konkretnych odbiorców, którzy mają mieć dostęp do strony. Przeczytaj artykuł Zarządzanie odbiorcami w portalu.
   W przeciwnym razie wybierz jedną z tych opcji:
   • Użytkownicy anonimowi, aby zezwolić wszystkim użytkownikom na wyświetlanie strony.
   • Zarejestrowani użytkownicy, aby zezwolić na wyświetlanie strony tylko zarejestrowanym 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. Patrz Informacje o adresach URL wywołań zwrotnych.

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

1. uzyskać 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 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ą interfejsu API na stronie interfejsów API, dodaj lub zmień bieżący obraz.

Aby zarządzać obrazem karty interfejsu API:

1. uzyskać 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:

   • Jeśli nie jest wybrany żaden obraz, kliknij Wybierz obraz, by określić lub przesłać obraz.
   • Kliknij Zmień obraz, aby określić lub przesłać inny obraz.
   • Aby go usunąć, kliknij na obrazie x.

   Określając obraz, podaj obraz z zewnętrznym adresem URL używanym na potrzeby elementu katalogu lub ścieżkę pliku z plikami obrazu przechowywanymi w portalu, np. /files/book-tree.jpg. Gdy podasz adres URL obrazu zewnętrznego, obraz nie zostanie przesłany do Twoich zasobów. Ponadto wczytywanie obrazu w zintegrowanym portalu będzie zależało od jego dostępności, które może być blokowane lub ograniczone przez zasady bezpieczeństwa treści.

6. Kliknij Zapisz.

Tagowanie interfejsu API za pomocą kategorii

Dodaj do interfejsu API tagi na jeden z tych sposobów:

• Zarządzaj kategoriami, do których interfejs API jest otagowany podczas jego edytowania, zgodnie z opisem poniżej.
• Zarządzaj interfejsami API otagowanymi w kategorii podczas edytowania kategorii.

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

1. uzyskać 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 pole 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. uzyskać 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 razie potrzeby zmodyfikuj pola Wyświetlany tytuł i Wyświetlany opis.
6. Kliknij Zapisz.

Usuwanie interfejsu API z portalu

Aby usunąć interfejs API z portalu:

1. uzyskać dostęp do katalogu interfejsów API,
2. Wybierz Interfejsy API, jeśli nie jest jeszcze wybrany.
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 zgodnie z opisem w sekcjach poniżej.

Poznawanie strony Kategorie

Aby wyświetlić stronę Kategorie:

1. Kliknij 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świetlanie kategorii i interfejsów API, do których zostały oznaczone tagami
• Dodaj kategorię
• Edytowanie kategorii
• Usuwanie kategorii
• Zarządzaj interfejsami API opublikowanymi w Twoim portalu. Zobacz Katalog interfejsów API

Dodawanie kategorii

Dodaj kategorię, korzystając z jednego z tych sposobów:

• Wpisz nazwę kategorii podczas dodawania do portalu interfejsu API.
• Ręcznie dodaj kategorię w sposób opisany 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 do oznaczenia kategorii.
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

Gdy usuniesz kategorię, wszystkie dodane do niej tagi interfejsu API również zostaną usunięte.

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. Dodaj lub usuń interfejsy API.
6. Kliknij Zapisz.

Rozwiązywanie problemów z opublikowanymi interfejsami API

W kolejnych sekcjach znajdziesz informacje, które pomogą Ci rozwiązywać problemy z określonymi błędami w opublikowanych interfejsach API.

Błąd: nie udało się pobrać błędu, który został zwrócony podczas korzystania z funkcji Wypróbuj ten interfejs API

Jeśli podczas korzystania z tego interfejsu API zwracany jest błąd TypeError: Failed to fetch, sprawdź te możliwe przyczyny i rozwiązania:

• W przypadku błędów związanych z treścią o różnych ustawieniach SSL może on być spowodowany znanym problemem z interfejsem Swagger-ui. Jednym z możliwych obejścia tego problemu jest wpisanie HTTPS przed HTTP w definicji schemes w dokumencie OpenAPI. Na przykład:

  schemes:
     - https
     - http
  

• W przypadku błędów związanych z ograniczeniami udostępniania zasobów między serwerami (CORS) upewnij się, że serwery proxy interfejsu API obsługują CORS. CORS to standardowy mechanizm, który umożliwia obsługę żądań z innych domen po stronie klienta. Zapoznaj się z informacjami na temat konfigurowania serwera proxy interfejsu API w celu 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 funkcji Wypróbuj ten interfejs 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, by do ustawiania nagłówków CORS zamiast <Add> używała <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: niedozwolone pole nagłówka żądania

Jeśli podczas korzystania z tego interfejsu API wystąpi błąd Request header field not allowed, podobnie jak w przykładzie poniżej, może być konieczne zaktualizowanie 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 zwróci token o wartości BearerToken zamiast oczekiwanej wartości Bearer zgodnej ze standardem RFC. Ta nieprawidłowa odpowiedź token_type może spowodować wyświetlenie błędu Access denied podczas korzystania z funkcji Wypróbuj ten interfejs API.

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