Skip to main content
ページネーションにより、現在のサイトで閲覧可能な開発者ドキュメントを返します。検索、インデックス作成、またはクライアント側でのナビゲーション構築に使用できます。一覧には現在、各ドキュメントの content とネストされた親情報が含まれており、レスポンスが大きくなる可能性があります。

API 概要

クエリパラメータ

現在の一覧 API は alias または parent_id によるフィルタリングをサポートしていません。alias が判明している場合は直接ドキュメント詳細を呼び出してください;ツリー型ナビゲーションを構築する場合は、一度ページネーションで取得した後、各項目の parent.id を使用してクライアント側でグループ化してください。

リクエスト例

レスポンス構造

一覧では DocumentIndexSerializer を使用しており、現在はモデルフィールドおよびネストされた関係を返します;関連 API ドキュメントには api_method が含まれる場合もあります。フィールドは後方互換性を保ちながら追加される可能性があるため、クライアントは必要に応じて読み取る必要があります。children、解析後のコンテンツ言語、およびコンテンツハッシュが必要な場合は、詳細 API を使用してください。 ソースドキュメントに関連付けられた公開レコードでは、content_source がソースドキュメントの識別子、ソースコンテンツハッシュ、リクエストされた言語、翻訳更新時刻、および ready、stale、missing、missing_source または ambiguous の状態を提供します;その他のレコードでは、このフィールドは null です。ready 時の content_hash はその言語の翻訳文に対応します。本文は、翻訳文が存在しない場合の言語フォールバックを含め、引き続き従来のルールに従って表示されます;ドキュメントを同期する必要があるクライアントは、状態とハッシュの両方を確認する必要があり、本文が空でないことだけで更新済みと判断してはなりません。

使用上の推奨事項

  • レスポンスには本文が含まれるため、一括同期時はページネーションを使用して適切なタイムアウトを設定し、同じページを並行して取得しないでください。
  • alias は公開ページ URL の安定した識別子です;alias が判明している場合は直接 /api/v1/documents/{alias} をリクエストしてください。
  • 現在の API では親によるサーバー側フィルタリングはできません;ナビゲーションを構築する際は、クライアント側で parent.id によりグループ化してください。

関連 API