3.2. 创建 API 草案
使用 Apicurio Studio web 控制台创建 OpenAPI 或 AsyncAPI 定义。
先决条件
- 您已登录到 Apicurio Studio web 控制台。
流程
- 在 Apicurio Studio web 控制台中,单击 Create draft。
完成向导来为新草案提供以下详情:
指定 Draft Coordinates 并点 Next :
-
组 ID 和 Draft ID :使用默认空设置自动生成 Draft ID,并将 Draft 添加到
默认的
Draft 组中。或者,您可以输入可选组 ID 或 Draft ID。 - 版本号 :可选指定版本号。
- 键入 :使用默认 Auto-Detect 设置来自动检测 Draft 类型(如果创建空的 Draft),或者从列表中选择 Draft 类型,如 OpenAPI。
-
组 ID 和 Draft ID :使用默认空设置自动生成 Draft ID,并将 Draft 添加到
指定 Draft 内容 并点 Next :
从模板 :从模板列表中选择。
-
从本地文件 :单击 Browse,然后选择一个文件,或者拖放文件。例如,
my-openapi.json
或my-schema.proto
。或者,您可以在文本框中输入文件内容。 -
从 URL :输入有效且可访问的 URL,然后单击 Fetch。例如:
https://petstore3.swagger.io/api/v3/openapi.json
。
-
从本地文件 :单击 Browse,然后选择一个文件,或者拖放文件。例如,
指定 Draft 元数据 :
- Name :输入第一个工件版本的可选友好名称。
- 描述 :输入第一个工件版本的可选描述。
- 点 Create 创建草稿。此时会显示 Draft 详情视图。
要编辑草案,请点击 Edit draft。
点 Design 选项卡,并选择性地按照如下方式编辑草案:
- 提供版本号和描述。
- (仅限 AsyncAPI) 定义服务条款。
- 添加您的联系信息:名称、电子邮件地址和 URL。
- 选择许可证。
- (仅限 OpenAPI) 定义标签。
- 定义一个或多个服务器。
- 配置安全方案。
- (仅限 OpenAPI) 指定安全要求。
- (仅限 OpenAPI) 配置供应商扩展。
- 点 Source 选项卡,并查看草案的实时预览。当您编辑编辑器页面中的值时,Source 选项卡的内容会自动更新。
- (可选) 要查看自上次保存以来所做的更改,请点击 Actions > Show draft changes。
(可选) 在草案编辑器的左侧窗格中,您可以添加以下项目:
- (仅限 OpenAPI) 资源路径、数据类型和响应
- (仅限 AsyncAPI) Channels、数据类型、消息、操作特征和消息特征
- 点击 Save。
- 使用面包屑导航栏返回 Drafts 页面。
使用组 ID 和 Draft ID 在 Drafts 页面中列出了新的草案。您可以使用选项图标(三个垂直圆点)来查看草案详情、编辑草案内容、完成草稿、查看 Apicurio Registry 中的草案,或删除草案。
其他信息
请查看 第 3.4 节 “最终调整草案”