定义常规 API 信息
上次更新日期:2026/10/20
编辑有关您的 API 版本的常规信息,并定义其媒体类型、服务器 URL 和安全方案。
- 访问您的 API 的常规信息页面。
创建您的 API 后,此页面会自动打开。您也可以通过点击左侧面板顶部的 API 名称来打开它。
- 在常规部分,编辑您的 API 的版本、描述、联系信息、许可详细信息和服务条款。
信息注释注意:您可以在
API 协定主页更改您的 API 名称。有关更多信息,请参阅
使用新 API。
- 编辑媒体类型部分以添加或删除媒体类型。
本部分中定义的媒体类型是全局的,它们适用于整个 API 版本。它们也可以在操作级别进行定义。
- 在 Server URLs 部分添加您的服务器 URL。
此部分中定义的服务器 URL 是全局的,它们适用于整个 API 版本。定义后,您的服务器 URL 将显示在左侧面板顶部您的 API 名称下方;如果启用了 Mock 端点,该端点也会一并显示。
已发布的服务器 URL 在实时文档中可见。未发布的服务器 URL 仅在 API 契约中可见。
- 在全局安全性和安全方案部分中定义 API 的安全性。
本部分中定义的安全设置是全局的,适用于整个 API 版本。它也可以在资源和操作级别进行定义。