이 가이드에서는 Developer Knowledge API를 시작하는 방법을 보여줍니다. 개발자 지식 API를 사용 설정하고, API 키를 가져오고, 첫 번째 API 호출을 실행하여 개발자 문서를 검색하고 가져오는 방법을 알아봅니다.
시작하기 전에
API 사용 설정
- Google API 라이브러리에서 Developer Knowledge API 페이지를 엽니다.
- API를 사용할 프로젝트가 올바르게 선택되어 있는지 확인합니다.
- 사용 설정을 클릭합니다. API를 사용 설정하거나 사용하는 데 필요한 특정 IAM 역할은 없습니다.
API 키 만들기 및 보안 설정
- API를 사용 설정한 프로젝트의 Google Cloud 콘솔에서 사용자 인증 정보 페이지로 이동합니다.
- 사용자 인증 정보 만들기를 클릭한 후 메뉴에서 API 키를 선택합니다. API 키 생성 완료 대화상자에 새로 생성된 키의 문자열이 표시됩니다.
- API 키 수정을 클릭합니다.
- 이름 필드에 키 이름을 입력합니다.
- API 제한사항에서 키 제한을 선택합니다.
-
API 선택 목록에서 Developer Knowledge API를 사용 설정하고 확인을 클릭합니다.
- 참고: 개발자 지식 API를 방금 사용 설정한 경우 API 선택 목록에 표시되기까지 지연이 발생할 수 있습니다.
- 저장을 클릭합니다.
문서 청크 검색
Developer Knowledge API 키가 있으면 API를 사용할 수 있습니다. 다음 예에서는 'BigQuery'와 관련된 문서 청크를 검색하는 방법을 보여줍니다.
Developer Knowledge API 키를 환경 변수에 저장합니다.
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"YOUR_API_KEY를 생성한 API 키로 바꿉니다.curl을 사용하여searchDocumentChunks엔드포인트를 호출합니다.curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"
이 명령어는 콘텐츠의 스니펫과 각 문서의 parent를 비롯하여 쿼리와 일치하는 문서 청크 목록을 반환합니다.
문서 가져오기
searchDocumentChunks의 응답에는 문서 청크 목록이 포함됩니다.
각 문서 청크에는 parent 필드가 있으며, 이를 사용하여 GetDocument로 문서의 전체 콘텐츠를 가져올 수 있습니다.
searchDocumentChunks 호출에서 반환된 문서 청크 중 하나의 parent를 복사하고 (예: documents/developers.google.com/...) 환경 변수에 저장한 후 curl를 사용하여 GetDocument 엔드포인트를 호출합니다.
export DOC_NAME="DOCUMENT_NAME"
curl "https://developerknowledge.googleapis.com/v1alpha/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"
그러면 지정된 문서의 전체 마크다운 콘텐츠가 반환됩니다.