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」ボタンが表示され、Cursor や Cline などの MCP 対応 IDE に API ドキュメントを接続する方法をユーザーに案内します。これにより、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 ファイルを使用する一般的な方法は 2 つあります。

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 アシスタントとの会話に貼り付けます。

プロンプト例:

「Based on this endpoint definition, please generate a TypeScript client: (paste the copied content here).」

FAQ

llms.txt を有効にすると、ドキュメントのセキュリティに影響しますか？

いいえ。 llms.txt には、すでに公開されているコンテンツのみが含まれます。HTML を Markdown に変換するだけで、非公開または未公開のドキュメントを公開することはありません。アクセス制御（パスワード、IP 許可リスト、メール許可リストなど）が設定されている場合、ユーザーは llms.txt と Markdown ファイルにアクセスするために引き続き認証を通過する必要があります。

ドキュメントがパスワード、IP、またはメール許可リストで保護されている場合でも llms.txt を使用できますか？

Apidog App で `Copy Page` ボタンが表示されないのはなぜですか？

AI アシスタントで「Web Search」機能を有効にしました。なぜ URL 経由で Web ページの内容を読み取れないのですか？

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