API 문서의 검색 기능을 향상시키기 위해 Apidog를 Algolia와 통합하는 방법을 알아보십시오.
기본적으로 게시된 API 문서에는 사용자가 이름 또는 경로로 엔드포인트나 문서를 검색할 수 있는 기본 제공 검색 기능이 포함되어 있습니다.또한 Apidog는 검색 기능을 향상시키기 위해 Algolia와의 통합을 제공합니다. 이 기능을 활용하려면 해당 기능을 활성화하고 필요한 구성을 완료해야 합니다.Apidog 버전 v2.6.31 이상이 필요합니다.
Algolia와 Apidog 통합#
1단계: Algolia 계정 생성#
2.
등록 후 Algolia 계정에 로그인하십시오.
2단계: Algolia 애플리케이션 생성#
1.
로그인한 후 Algolia 대시보드에서 새 애플리케이션을 생성하십시오.
2.
Upload a File을 클릭하여 데이터를 업로드하십시오.
처음 설정을 더 쉽게 진행하려면 제공된 예제 코드를 사용하여 JSON 파일을 생성할 수 있습니다. JSON 파일을 Algolia로 끌어다 놓기만 하면 됩니다. JSON 파일의 이름이 Index Name이 되며, 이는 나중에 Apidog의 문서 검색 구성에서 필요합니다.
4.
최종 단계에 도달할 때까지 Next를 클릭하여 진행하십시오.
5.
최종 단계에서는 검색 프런트엔드를 어떻게 구축할지 묻는 메시지가 표시됩니다. 이 옵션은 건너뛸 수 있습니다.
3단계: Algolia 설정으로 Apidog 구성#
1.
Algolia Settings -> API Keys 페이지로 이동하여 애플리케이션의 구성 세부 정보를 가져오십시오.
2.
이러한 구성 세부 정보를 복사하여 Apidog의 문서 검색 설정에 입력 하십시오.
4단계: 기능 저장 및 활성화#
Apidog에서 필요한 구성 세부 정보를 입력한 후 설정을 저장하여 향상된 검색 기능을 활성화하십시오.무료 플랜의 제한에 도달하면 Apidog에서 알림이 표시됩니다. Ask AI#
Ask AI 기능을 사용하면 사용자가 문서 검색 내에서 직접 대화형 AI 기반 Q&A를 경험할 수 있습니다. 아래와 같이 Documentation Search 설정에서 assistant_id를 바인딩하여 Ask AI 기능을 활성화할 수 있습니다.Algolia Ask AI 허용 소스 또는 화이트리스트에 아래 이미지와 같이 Apidog 문서 URL/도메인을 추가하십시오.무료 Algolia DocSearch 플랜#
신청이 성공적으로 완료되면 Algolia에서 확인 이메일을 보내며, Algolia 대시보드에서 애플리케이션 참여를 초대하는 메시지를 받게 됩니다. Algolia가 제공하는 애플리케이션에 참여하려면 클릭하여 확인하십시오.확인 후 위에서 언급한 것과 동일한 절차에 따라 애플리케이션의 구성 세부 정보를 가져오고 Apidog 프로젝트와 바인딩하십시오.