Skip to main content
Zwraca stronicowaną listę dokumentów deweloperskich widocznych w bieżącej witrynie, którą można wykorzystać do wyszukiwania, indeksowania lub samodzielnego budowania nawigacji po stronie klienta. Lista obecnie zawiera content każdej dokumentacji oraz zagnieżdżone informacje o elemencie nadrzędnym, a odpowiedź może być duża.

Przegląd interfejsu API

Parametry zapytania

Obecny interfejs listy nie obsługuje filtrowania alias ani parent_id. Gdy alias jest znany, wywołaj bezpośrednio szczegóły dokumentu; podczas budowania nawigacji drzewiastej po pobraniu stron użyj parent.id każdego elementu do grupowania po stronie klienta.

Przykład żądania

Struktura odpowiedzi

Lista używa DocumentIndexSerializer i obecnie zwraca pola modelu oraz zagnieżdżone relacje; powiązane dokumenty API mogą również zawierać api_method. Pola mogą być dodawane w sposób zgodny wstecznie, a klient powinien odczytywać je w razie potrzeby. Gdy potrzebne są children, przeanalizowany język treści i hash treści, użyj interfejsu szczegółów. W przypadku publicznych rekordów powiązanych z dokumentami źródłowymi, content_source dostarcza identyfikator dokumentu źródłowego, hash treści źródłowej, żądany język, czas aktualizacji tłumaczenia oraz status ready, stale, missing, missing_source lub ambiguous; dla pozostałych rekordów to pole ma wartość null. content_hash przy statusie ready odpowiada tłumaczeniu w tym języku. Treść główna jest nadal wyświetlana według pierwotnych zasad, w tym z powrotem do innego języka w przypadku braku tłumaczenia; klienci, którzy muszą synchronizować dokumenty, powinni jednocześnie sprawdzać status i hash, a nie oceniać aktualizacji wyłącznie na podstawie niepustej treści głównej.

Zalecenia dotyczące użycia

  • Odpowiedź zawiera treść główną; podczas synchronizacji zbiorczej używaj stronicowania i ustaw rozsądny limit czasu, nie pobieraj współbieżnie tej samej strony.
  • Alias jest stabilnym identyfikatorem URL publicznej strony; gdy alias jest znany, zażądaj bezpośrednio /api/v1/documents/{alias}.
  • Obecny interfejs nie może filtrować po stronie serwera według elementu nadrzędnego; podczas budowania nawigacji grupuj po stronie klienta według parent.id.

Powiązane interfejsy API