> 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)
- [OpenAPI レイアウト](https://gitbook.com/docs/documentation/ja-gitbook-documentation/api-references/guides/openapi-layouts.md): API リファレンスで、タグごとに 1 ページとオペレーションごとに 1 ページのどちらにするかを選べます
- [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 オペレーションを experimental、deprecated に設定したり、ドキュメントから非表示にしたりする方法を学びます
- [「Test it」ボタンの設定](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.