第 3 章 将 ActiveDocs 添加到 3scale
3scale 提供了一个框架，供您的 API 创建交互式文档。
使用 OpenAPI 规格(OAS)，您可以获得 API 的功能文档，这有助于开发人员探索、测试并与 API 集成。
3.1. 在 3scale 中设置 ActiveDocs
您可以在 3scale 用户界面中的 API 中添加 ActiveDocs，以获取一个用于为 API 创建交互式文档的框架。
先决条件
- 定义 API 的 OpenAPI 文档。
-
3scale 2.14 实例租户的凭据（
token或provider_key）。
流程
在管理门户中导航至 [your_API_name]
ActiveDocs。3scale 显示您的 API 服务规格列表。这最初为空。 您可以根据需要添加任意数量的服务规格。通常，每个服务规格对应于您的 API 之一。例如，3scale 具有每个 3scale API 的规格，如服务管理、帐户管理、分析和 Billing。
点 Create a new spec。
当您添加新服务规格时，提供以下内容：
- Name
系统名称
这是从 Developer Portal 中引用服务规格所必需的。
选择是否希望发布规格。如果没有发布，则开发人员门户中不提供新规格。
注意如果您创建但不要发布新的规格，则在选择时，将保留供您的发布。
- 添加仅用于您的消耗的描述。
添加 API JSON 规范。
根据 OpenAPI 规格(OAS)建议的规格生成您的 API 规格。在本教程中，我们假定您已拥有符合 API 的有效 OAS 规范。
使用第一个 ActiveDoc
添加第一个 ActiveDoc 后，您可以看到它列在 [your_API_name]
您可以通过点您提供服务规格的名称来预览您的 ActiveDocs 看起来，例如 Pet Store。即使规格尚未发布，您也可以执行此操作。
以下是 ActiveDoc 的意义：
