AI 기능

AI 어시스턴트 및 개발 도구와 원활하게 통합할 수 있는 AI 기능을 통해 API 문서를 AI에 적합하게 준비하십시오. 이러한 기능은 개발자가 Cursor, Cline 및 기타 AI 기반 IDE와 같은 AI 도구를 활용하여 API 통합 및 코드 생성을 가속화하는 데 도움이 됩니다.

버전 요구 사항

이러한 기능에 액세스하려면 Apidog 버전이 ≥ 2.7.2여야 합니다.

이러한 기능을 활성화하려면: Publish Docs → Publish Docs Sites → AI Features로 이동하십시오.

Ask AI

이 기능은 문서 페이지에서 대화형 검색 기능을 활성화합니다. Algolia의 AI Assistant를 연결하여 이 기능을 사용할 수 있습니다. 이 기능에 대한 자세한 내용은 Documentation Search 페이지의 Ask AI 섹션에서 확인하실 수 있습니다.

MCP(Model Context Protocol) 활성화

활성화하면 문서에 "MCP" 버튼이 표시되어 사용자가 API 문서를 Cursor 및 Cline과 같은 MCP 지원 IDE에 연결하는 방법을 안내합니다. 이를 통해 Agentic AI가 API 문서에서 직접 코드 생성을 지원할 수 있습니다.

자세히 알아보기

자세한 설정 지침은 다음을 참조하십시오. Connect Online API Documentation Published by Apidog to AI via Apidog MCP Server.

Copy Page 활성화

활성화하면 문서에 "Copy page" 버튼이 표시되어 사용자가 현재 페이지를 Markdown 형식으로 복사할 수 있습니다. AI 대화에 붙여넣기에 적합합니다.

llms.txt 활성화

활성화하면 문서 사이트의 루트 디렉터리에 llms.txt Markdown 파일이 자동으로 생성됩니다. 이 파일에는 간결한 설명과 함께 모든 Markdown 페이지에 대한 링크가 포함되어 있어 AI 어시스턴트가 문서를 쉽게 발견하고 탐색할 수 있습니다.

예시:

AI 어시스턴트가 llms.txt를 사용하는 방법

llms.txt 및 관련 Markdown 파일을 사용하는 일반적인 방법은 두 가지입니다.

1. URL에 액세스할 수 있는 AI 어시스턴트와 Markdown 링크 공유

Apidog를 통해 게시된 각 온라인 문서 페이지에는 Markdown 버전이 있습니다. 다음을 수행할 수 있습니다.

모든 문서 URL에 ".md"를 추가합니다(예: https://example.apidog.io/page.md).

또는 온라인 문서에서 "View as Markdown"을 클릭합니다.

Web Browsing 기능이 있는 AI 어시스턴트는 이러한 ".md" URL을 사용하여 간결한 문서를 가져올 수 있습니다.

예를 들어 Cursor에서는 "Understand this info: @https://zojphlasi1.apidog.io/find-pet-by-id-12888653e0.md and help me generate a TypeScript client"라고 요청할 수 있습니다.

프롬프트 형식

프롬프트 형식은 사용 중인 AI 도구의 특정 규칙을 따라야 합니다. 예를 들어 Cursor에서는 URL이 컨텍스트로 인식되려면 @로 시작해야 합니다.

2. URL에 액세스할 수 없는 AI 어시스턴트를 위해 Markdown 콘텐츠 복사

AI 어시스턴트가 URL을 통해 콘텐츠에 액세스할 수 없는 경우 Markdown 콘텐츠를 수동으로 복사하여 붙여넣어야 합니다.

온라인 문서에서 "Copy Page" 버튼을 클릭하여 현재 페이지 콘텐츠를 Markdown 형식으로 가져온 다음, AI 어시스턴트와의 대화에 붙여넣으십시오.

예시 프롬프트:

"이 엔드포인트 정의를 기반으로 TypeScript 클라이언트를 생성해 주십시오. (복사한 콘텐츠를 여기에 붙여넣으십시오)."

FAQ

llms.txt를 활성화하면 문서 보안에 영향을 줍니까?

아니요. llms.txt에는 이미 공개적으로 게시된 콘텐츠만 포함됩니다. 이는 단순히 HTML을 Markdown으로 변환할 뿐이며, 비공개 또는 게시되지 않은 문서를 노출하지 않습니다. 액세스 제어(비밀번호, IP 허용 목록, 이메일 허용 목록 등)가 구성되어 있는 경우에도 사용자는 llms.txt 및 Markdown 파일에 액세스하려면 인증을 통과해야 합니다.

문서가 비밀번호, IP 또는 이메일 허용 목록으로 보호되는 경우에도 llms.txt를 사용할 수 있습니까?？

Apidog App에서 `Copy Page` 버튼이 보이지 않는 이유는 무엇입니까?

AI 어시스턴트에 'Web Search' 기능을 활성화했습니다. 그런데 URL을 통해 웹 페이지 콘텐츠를 읽을 수 없는 이유는 무엇입니까?

AI 어시스턴트가 URL을 통해 Markdown 파일에 액세스하지 못하는 경우 어떻게 해야 합니까?

llms.txt를 활성화한 후 다른 작업을 해야 합니까?

llms.txt가 제대로 작동하는지 어떻게 확인할 수 있습니까?

Ask AI#

MCP(Model Context Protocol) 활성화#

Copy Page 활성화#

llms.txt 활성화#

AI 어시스턴트가 llms.txt를 사용하는 방법#

FAQ#

Ask AI

MCP(Model Context Protocol) 활성화

Copy Page 활성화

llms.txt 활성화

AI 어시스턴트가 llms.txt를 사용하는 방법

FAQ