如何在Azure APIM开发者门户显示请求字段的长度?
在Azure APIM开发者门户中显示请求字段的长度约束
要在Azure APIM开发者门户中展示Open API定义里的minLength和maxLength约束,需要自定义开发者门户的前端组件,具体步骤如下:
启用开发者门户自定义模式
进入你的Azure APIM实例,打开开发者门户,点击右上角的「编辑」按钮,进入自定义编辑模式。定位请求字段展示组件
在门户的组件库中,找到API详情页内负责展示请求参数/请求体字段的组件(通常名为RequestFields),选中该组件后进入模板编辑界面。修改组件模板添加长度列
编辑组件的Handlebars模板,在现有的表头行(包含名称、类型、必填、描述的<tr>标签)中添加新的表头:<th>长度约束</th>然后在每一行字段的
<tr>模板里,对应位置添加显示长度约束的单元格:<td> {{#if schema.minLength}}最小{{schema.minLength}}{{/if}} {{#if schema.maxLength}}{{#if schema.minLength}} / {{/if}}最大{{schema.maxLength}}{{/if}} {{#unless schema.minLength}}{{#unless schema.maxLength}}无{{/unless}}{{/unless}} </td>这段代码会自动读取Open API Schema中的
minLength和maxLength属性,组合展示长度范围,无约束时显示「无」。保存并发布门户
完成模板修改后保存组件,点击门户右上角的「发布」按钮,将自定义内容部署到生产环境的开发者门户。
另外,如果暂时不想做组件自定义,也可以在Open API字段的description属性中手动添加长度约束说明(比如"description": "用户名称,最小长度2,最大长度20"),这样门户会直接在描述列展示该信息,但这种方式需要手动维护,无法自动同步Schema中的配置。
内容的提问来源于stack exchange,提问作者Kishan Vaishnav
相关产品推荐
相关产品推荐

