# 在你的文档中插入 API 参考

GitBook 允许你根据 OpenAPI 规范中已有的端点自动生成相关页面。这些页面将包含 OpenAPI 操作块，使你和访问者能够测试你的端点，并根据规范中找到的信息进一步探索它们。

{% hint style="success" %}
从你的规范中添加的端点将在规范更新时持续更新。请参见 [更新你的规范](https://gitbook-v2-q67etdj25-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/api-references/add-an-openapi-specification#update-your-specification) 部分以了解更多信息。
{% endhint %}

### 根据你的规范自动创建 OpenAPI 页面

在你已 [添加 OpenAPI 规范](https://gitbook-v2-q67etdj25-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/api-references/openapi/add-an-openapi-specification)之后，你可以通过插入一个 **OpenAPI 参考** 到 Space 的目录中来生成端点页面。

<figure><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2FYy8gCqxfaO4xjv2eqiL5%2Fcreate_api_pages%402x.png?alt=media&#x26;token=62b8386b-9fea-4233-b961-b6a1e582411e" alt="A GitBook screenshot showing how to insert API references into the table of contents of a space"><figcaption><p>在 Space 的目录中插入 API 参考。</p></figcaption></figure>

{% stepper %}
{% step %}
**从 OpenAPI 生成页面**

在你想要生成端点页面的 Space 中，点击 **添加新内容...** 按钮，位于你的 Space 的底部 [目录](https://gitbook-v2-q67etdj25-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/zi-yuan/gitbook-ui#table-of-contents).

在这里，点击 **OpenAPI 参考**.
{% endstep %}

{% step %}
**选择你的 OpenAPI 规范**

选择你之前上传的 OpenAPI 规范，然后点击 **插入** 即可自动将你的端点添加到 Space 中。你也可以选择添加一个模型页面，以引用你所有的 OpenAPI schema。
{% endstep %}

{% step %}
**管理你的 API 操作**

GitBook 将根据你的 OpenAPI 规范以及其中定义的标签自动生成页面。

前往 [structuring-your-api-reference](https://gitbook-v2-q67etdj25-gitbook.vercel.app/url/gitbook.com/docs/documentation/zh/api-references/guides/structuring-your-api-reference "mention") 以进一步了解如何通过你的 OpenAPI 规范组织你的操作。
{% endstep %}
{% endstepper %}

### 添加单个 OpenAPI 块

或者，你可以将规范中的 OpenAPI 操作或 schema 单独添加到文档中的各个页面。

{% stepper %}
{% step %}
**添加新的 OpenAPI 块**

按下以下键打开块选择器 **/**，并搜索 OpenAPI。
{% endstep %}

{% step %}
**选择你的 OpenAPI 规范**

选择你之前上传的 OpenAPI 规范，然后点击 **继续** 以选择你想使用的端点。
{% endstep %}

{% step %}
**选择你想插入的操作或 schema**

选择你想插入到文档中的操作和 schema，然后点击 **插入**.
{% endstep %}
{% endstepper %}