Skip to main content
페이지네이션을 통해 현재 사이트에서 볼 수 있는 개발자 문서를 반환하며, 검색, 인덱싱 또는 클라이언트에서 자체적으로 탐색을 구축하는 데 사용할 수 있습니다. 목록에는 현재 각 문서의 content 및 중첩된 상위 정보가 포함되어 있으며, 응답이 클 수 있습니다.

인터페이스 개요

쿼리 매개변수

현재 목록 인터페이스는 alias 또는 parent_id 필터링을 지원하지 않습니다. alias를 알고 있는 경우 문서 상세를 직접 호출하십시오; 트리형 탐색을 구축할 때는 한 번에 페이지네이션으로 가져온 후, 각 항목의 parent.id를 사용하여 클라이언트에서 그룹화하십시오.

요청 예시

응답 구조

목록은 DocumentIndexSerializer를 사용하며, 현재 모델 필드 및 중첩 관계를 반환합니다; 연결된 API 문서는 api_method를 포함할 수도 있습니다. 필드는 하위 호환 방식으로 추가될 수 있으므로, 클라이언트는 필요에 따라 읽어야 합니다. children, 파싱된 콘텐츠 언어 및 콘텐츠 해시가 필요한 경우 상세 인터페이스를 사용하십시오. 소스 문서에 연결된 공개 레코드의 경우, content_source는 소스 문서 식별자, 소스 콘텐츠 해시, 요청된 언어, 번역 업데이트 시간 및 ready, stale, missing, missing_source 또는 ambiguous 상태를 제공합니다; 다른 레코드에서는 이 필드가 null입니다. ready일 때의 content_hash는 해당 언어 번역문에 대응합니다. 본문은 번역문이 없을 때의 언어 폴백을 포함하여 기존 규칙에 따라 계속 표시됩니다; 문서를 동기화해야 하는 클라이언트는 상태와 해시를 동시에 확인해야 하며, 본문이 비어 있지 않은지만으로 업데이트되었는지 판단할 수 없습니다.

사용 권장 사항

  • 응답에는 본문이 포함되므로, 일괄 동기화 시 페이지네이션을 사용하고 적절한 타임아웃을 설정하며, 같은 페이지를 동시에 가져오지 마십시오.
  • alias는 공개 페이지 URL의 안정적인 식별자입니다; alias를 알고 있는 경우 /api/v1/documents/{alias}를 직접 요청하십시오.
  • 현재 인터페이스는 상위 항목 기준 서버 측 필터링을 할 수 없습니다; 탐색을 구축할 때 클라이언트에서 parent.id 기준으로 그룹화하십시오.

관련 인터페이스