> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references.md).

# 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
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.