在文档中插入 API 参考

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

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

从规范添加的端点将在您每次更新规范时持续更新。参见 更新您的规范 部分以获取更多信息。

从规范自动创建 OpenAPI 页面

在您 添加了您的 OpenAPI 规范之后，您可以通过在空间的目录中插入一个 OpenAPI 引用 来生成端点页面。

在空间的目录中插入 API 引用。

1

从 OpenAPI 生成页面

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

在此处，点击 OpenAPI 引用.

2

选择您的 OpenAPI 规范

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

3

管理您的 API 操作

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

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

添加单独的 OpenAPI 块

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

1

添加新的 OpenAPI 块

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

2

选择您的 OpenAPI 规范

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

3

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

挑选您想插入到文档中的操作和模式，然后点击 插入.