# API をドキュメント化する

- [OpenAPI](https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references/openapi.md): OpenAPI スペックをページに追加し、インタラクティブブロックでページ上からエンドポイントをテストできるようにします。
- [OpenAPI 仕様を追加する](https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references/openapi/add-an-openapi-specification.md): GitBook アプリまたは CLI から OpenAPI 仕様を追加・更新する方法を学びます
- [API リファレンスをドキュメントに挿入する](https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references/openapi/insert-api-reference-in-your-docs.md): OpenAPI スペックから完全な API リファレンスを挿入するか、個別の操作やスキーマを選択します
- [ガイド](https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references/guides.md)
- [API リファレンスの構成](https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references/guides/structuring-your-api-reference.md): アイコンと説明を使って、複数ページにまたがる API リファレンスの構成方法を学びます
- [カスタムコードサンプルの追加](https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references/guides/adding-custom-code-samples.md): API エンドポイントと並べて表示するカスタムコードサンプルを設定する方法を学びます
- [API 操作の管理](https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references/guides/managing-api-operations.md): OpenAPI の API 操作を実験的扱い、非推奨、またはドキュメントから非表示にする方法を学びます
- [「テストする」ボタンの設定](https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references/guides/configuring-the-test-it-button.md)
- [OpenAPI プロキシの使用](https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references/guides/using-openapi-proxy.md)
- [列挙型の説明](https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references/guides/describing-enums.md): 列挙型に説明を追加する方法を学びます
- [CI/CD との統合](https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references/guides/support-for-ci-cd-with-api-blocks.md): GitBook で OpenAPI 仕様の更新を自動化する方法を学びます
- [拡張機能リファレンス](https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references/extensions-reference.md): GitBook がサポートする OpenAPI 拡張機能の完全なリファレンス


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
