在文档中插入 API 参考

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

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

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

从你的规范自动创建 OpenAPI 页面

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

在 Space 的目录中插入 API 引用。

1

从 OpenAPI 生成页面

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

在这里，点击 OpenAPI 引用.

2

选择你的 OpenAPI 规范

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

3

管理你的 API 操作

GitBook 将基于你的 OpenAPI 规范及其定义中设置的标签自动生成页面。

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

添加单个 OpenAPI 块

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

1

添加新的 OpenAPI 块

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

2

选择你的 OpenAPI 规范

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

3

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

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