Skip to main content
Gibt die für die aktuelle Website sichtbaren Entwicklerdokumente paginiert zurück und kann für Suche, Indizierung oder zum eigenständigen Erstellen einer Navigation im Client verwendet werden. Die Liste enthält derzeit den content jeder Dokumentation und verschachtelte übergeordnete Informationen; die Antwort kann groß sein.

Schnittstellenübersicht

Abfrageparameter

Die aktuelle Listenschnittstelle unterstützt keine Filterung nach alias oder parent_id. Wenn der Alias bekannt ist, rufen Sie direkt die Dokumentdetails auf; beim Erstellen einer Baum-Navigation rufen Sie nach dem Abrufen einer Seite die Daten einmalig ab und gruppieren Sie sie im Client anhand von parent.id jedes Elements.

Anfragebeispiele

Antwortstruktur

Die Liste verwendet DocumentIndexSerializer und gibt derzeit Modellfelder und verschachtelte Beziehungen zurück; zugehörige API-Dokumente können außerdem api_method enthalten. Felder können abwärtskompatibel ergänzt werden; Clients sollten sie nach Bedarf lesen. Wenn children, die analysierte Inhaltssprache und der Inhaltshash benötigt werden, verwenden Sie die Detailschnittstelle. Für öffentliche Datensätze mit verknüpften Quelldokumenten stellt content_source die Kennung des Quelldokuments, den Hash des Quellinhalts, die angeforderte Sprache, den Aktualisierungszeitpunkt der Übersetzung sowie den Status ready, stale, missing, missing_source oder ambiguous bereit; bei anderen Datensätzen ist dieses Feld null. Der content_hash bei ready entspricht der Übersetzung in dieser Sprache. Der Textkörper wird weiterhin nach den ursprünglichen Regeln angezeigt, einschließlich des Sprach-Fallbacks bei fehlender Übersetzung; Clients, die Dokumente synchronisieren müssen, sollten sowohl Status als auch Hash überprüfen und nicht allein anhand eines nicht leeren Textkörpers beurteilen, ob er aktualisiert wurde.

Verwendungsempfehlungen

  • Die Antwort enthält den Textkörper; verwenden Sie bei der Batch-Synchronisierung Paginierung und setzen Sie ein angemessenes Timeout, und rufen Sie nicht dieselbe Seite parallel ab.
  • Der Alias ist die stabile Kennung der URL einer öffentlichen Seite; wenn der Alias bekannt ist, fordern Sie direkt /api/v1/documents/{alias} an.
  • Die aktuelle Schnittstelle kann nicht serverseitig nach übergeordneten Elementen filtern; gruppieren Sie beim Erstellen der Navigation im Client nach parent.id.

Verwandte Schnittstellen