如何在新版Azure API Management开发者门户添加OpenAPI定义下载功能?
新版Azure API Management开发者门户添加OpenAPI下载按钮及Swagger URL说明
一、添加OpenAPI定义下载按钮
- 进入开发者门户编辑模式:打开Azure APIM实例的开发者门户页面,点击顶部「编辑」按钮进入编辑状态。
- 定位到目标API详情页:在左侧导航栏选中需要配置的API,进入其详情页面。
- 添加并配置按钮组件:
- 点击页面右上角「添加组件」,找到「按钮」组件,拖拽到页面合适位置(如API详情页顶部、操作列表上方)。
- 设置按钮属性:
- 按钮文本设为「下载OpenAPI定义」。
- 动作选择「打开URL」,将URL设置为下方Swagger定义的访问地址(替换为你的APIM实例及API信息)。
- 可按需调整按钮样式(填充色、文字颜色等)以匹配门户主题。
- 保存并发布更改:完成配置后点击顶部「保存」,再点击「发布」使设置生效。
二、Swagger定义的特定访问URL
Azure APIM中每个API的Swagger/OpenAPI定义有固定访问格式:
面向开发者的公开访问URL
https://{你的APIM实例名称}.azure-api.net/{API名称}/swagger.json?api-version={版本号}
管理端访问URL(需权限验证)
https://{你的APIM实例名称}.management.azure-api.net/subscriptions/{订阅ID}/resourceGroups/{资源组名称}/providers/Microsoft.ApiManagement/service/{APIM实例名称}/apis/{API名称}/content?api-version=2023-03-01-preview
- 替换规则:将URL中的
{你的APIM实例名称}、{API名称}、{版本号}(若API启用版本控制)、{订阅ID}、{资源组名称}替换为实际信息。 - 权限说明:若API开启密钥验证,访问时需在请求头添加
Ocp-Apim-Subscription-Key参数,或在URL后追加subscription-key={订阅密钥}查询参数。
内容的提问来源于stack exchange,提问作者Houman Mohebbi
相关产品推荐
相关产品推荐

