Developer Knowledge API는 Google의 공개 개발자 문서에 프로그래매틱 방식으로 액세스할 수 있도록 지원하므로 이 기술 자료를 자체 애플리케이션 및 워크플로에 통합할 수 있습니다.
개요
Developer Knowledge API는 Google의 개발자 문서에 대한 머신 판독 가능 액세스를 위한 표준 소스로 설계되었습니다. 이 도구는 두 가지 주요 기능을 제공합니다.
SearchDocumentChunks를 사용하여 쿼리를 기반으로 관련 페이지 URI와 콘텐츠 스니펫을 찾습니다.GetDocument또는BatchGetDocuments를 사용하여 검색 결과의 전체 콘텐츠를 가져옵니다.
빠르게 시작하려면 빠른 시작 가이드를 따르세요.
검색 가능한 콘텐츠의 코퍼스는 코퍼스 참조에 나열되어 있습니다.
미리보기 참고사항: 이 미리보기 버전에서는 비구조적 마크다운 콘텐츠로 문서 페이지를 검색하고 가져오는 기능을 지원합니다.
API 사용 설정
Developer Knowledge API를 사용하려면 먼저 Google Cloud 프로젝트에서 사용 설정해야 합니다.
- Google API 라이브러리에서 Developer Knowledge API 페이지를 엽니다.
- API를 사용할 프로젝트가 올바르게 선택되어 있는지 확인합니다.
- 사용 설정을 클릭합니다. API를 사용 설정하거나 사용하는 데 필요한 특정 IAM 역할은 없습니다.
인증
Developer Knowledge API를 사용하려면 Developer Knowledge API 키가 필요합니다. 다음과 같이 만드세요.
- API를 사용 설정한 프로젝트의 Google Cloud 콘솔에서 사용자 인증 정보 페이지로 이동합니다.
- 사용자 인증 정보 만들기를 클릭한 후 메뉴에서 API 키를 선택합니다. API 키 생성 완료 대화상자에 새로 생성된 키의 문자열이 표시됩니다.
- API 키 수정을 클릭합니다.
- 이름 필드에 키 이름을 입력합니다.
- API 제한사항에서 키 제한을 선택합니다.
-
API 선택 목록에서 Developer Knowledge API를 사용 설정하고 확인을 클릭합니다.
- 참고: 개발자 지식 API를 방금 사용 설정한 경우 API 선택 목록에 표시되기까지 지연이 발생할 수 있습니다.
- 저장을 클릭합니다.
요청에 이 Developer Knowledge API 키를 포함합니다. 예를 들어 REST 호출은 key 쿼리 매개변수를 사용하여 이를 포함해야 합니다. 예는 빠른 시작 가이드를 참고하세요.
포함된 문서
API에서 검색하는 문서에 대한 자세한 내용은 코퍼스 참조를 참고하세요.
알려진 제한사항
- 마크다운 품질: 마크다운이 소스 HTML에서 생성됩니다. 불일치 또는 형식 문제가 있을 수 있습니다.
- 콘텐츠 범위: 코퍼스 참조의 공개 페이지만 포함됩니다. GitHub, OSS 사이트, 블로그, YouTube와 같은 다른 소스의 콘텐츠는 포함되지 않습니다.