在你的文档中插入 API 参考

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

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

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

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

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

将 API 参考插入到某个部分的目录中。

1

从 OpenAPI 生成页面

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

在这里，点击 OpenAPI 参考.

2

选择你的 OpenAPI 规范

选择你之前上传的 OpenAPI 规范。然后选择一个 页面结构:

• 每个标签一个页面
• 每个操作一个页面

你也可以选择添加模型页面和下载链接。点击 插入 以生成参考文档。

3

管理你的 API 操作

GitBook 会根据你的 OpenAPI 规范以及其定义中设置的标签自动生成页面。如果你选择 每个操作一个页面，GitBook 会按标签对生成的操作页面分组。

前往 OpenAPI 布局 来比较布局，或 构建你的 API 参考 用标签来组织页面。

添加单个 OpenAPI 块

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

1

添加新的 OpenAPI 块

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

2

选择你的 OpenAPI 规范

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

3

选择你想插入的操作或 schema

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