在文档中插入 API 参考

从你的 OpenAPI 规范中插入完整 API 参考，或选择单个操作或 schema

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

从你的规范中添加的端点将在规范更新时持续更新。请参见 更新你的规范 部分以了解更多信息。

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

在你已 添加 OpenAPI 规范之后，你可以通过插入一个 OpenAPI 参考 到 Space 的目录中来生成端点页面。

在 Space 的目录中插入 API 参考。

1

从 OpenAPI 生成页面

在你想要生成端点页面的 Space 中，点击 添加新内容... 按钮，位于你的 Space 的底部 目录.

在这里，点击 OpenAPI 参考.

2

选择你的 OpenAPI 规范

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

3

管理你的 API 操作

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

前往 构建你的 API 参考结构 以进一步了解如何通过你的 OpenAPI 规范组织你的操作。

添加单个 OpenAPI 块

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

1

添加新的 OpenAPI 块

按下以下键打开块选择器 /，并搜索 OpenAPI。

2

选择你的 OpenAPI 规范

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

3

选择你想插入的操作或 schema

选择你想插入到文档中的操作和 schema，然后点击 插入.