在文档中插入 API 参考

从您的 OpenAPI 规范插入完整的 API 参考，或选择单个操作或模式（schemas）。

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

来自规范的端点将在每次更新规范时继续被更新。请参阅 更新您的规范 部分以获取更多信息。

从规范自动创建 OpenAPI 页面

在您已经 添加了您的 OpenAPI 规范, 您可以通过在空间的目录中插入一个来生成端点页面， OpenAPI 参考 。

在空间的目录中插入 API 参考。

1

从 OpenAPI 生成页面

在您想生成端点页面的空间中，点击 添加新的... 按钮，位于空间底部的 目录（Table of Contents）.

在这里，点击 OpenAPI 参考.

2

选择您的 OpenAPI 规范

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

3

管理您的 API 操作

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

前往 构建您的 API 参考结构 以了解更多关于通过 OpenAPI 规范组织操作的信息。

添加单个 OpenAPI 模块

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

1

添加新的 OpenAPI 模块

按下以打开模块选择器 /，然后搜索 OpenAPI。

2

选择您的 OpenAPI 规范

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

3

选择您想插入的操作或模式

选择您想插入到文档中的操作和模式并点击 插入.