Skip to main content
Stronicowo zwraca punkty końcowe API widoczne w bieżącej witrynie. Nadaje się do wyszukiwania API według ścieżki biznesowej, usługi lub etapu publikacji; jeśli potrzebujesz tylko pełnej definicji jednego API, wywołaj bezpośrednio szczegóły API.

Przegląd interfejsu

Parametry zapytania

id, service_id, tag obecnie nie są parametrami filtrowania listy; ich przekazanie nie spowoduje odpowiedniego efektu filtrowania.

Opis odpowiedzi

Odpowiedź produkcyjna używa {count, items}. Każda pozycja listy obecnie zawiera pola modelu API, a także:
  • document_id: powiązany identyfikator dokumentacji deweloperskiej, może być pusty;
  • service_id / service: identyfikator głównej usługi i podsumowanie, mogą być puste;
  • definition: definicja OpenAPI, może być duża;
  • method, path, path2, stage, cost, tags, metadata itd.
Serializer listy obecnie zawiera definition; podczas pobierania pełnego katalogu należy używać stronicowania i ustawić limit czasu. Pola mogą być dodawane z zachowaniem kompatybilności wstecznej, klient powinien odczytywać tylko wymagane pola.

Następne kroki