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