在 Azure APIM 开发人员门户中显示长度

Question

如下图所示，即使 Open API json 中存在最大长度和最小长度，Azure APIM 开发人员门户中的请求也仅可见四列。

这是一个非常基本的功能，我尝试搜索文档，但找不到与此相关的任何内容。

有人可以帮我在开发者门户中显示请求字段的长度吗？

Answer 1

Azure API 管理 (APIM) 开发人员门户默认情况下不显示请求字段的 minLength 和

maxLength

约束。 您可以通过添加自定义小部件或修改现有模板来扩展开发者门户的功能，您可以参考此

链接

。 不过，您想让开发者门户中的用户看到约束，您可以手动将它们包含在 OpenAPI 规范中每个参数的

description

字段中。通过这种方式，可以有效地传达约束，而不需要定制开发。

在 OpenAPI (Swagger) 文件中找到参数定义。

• 更新
description
• 字段以包含

  minLength

  和

  maxLength

  信息。

{
  "name": "exampleParameter",
  "in": "query",
  "required": true,
  "description": "Example parameter (string, minLength: 3, maxLength: 10)",
  "schema": {
    "type": "string",
    "minLength": 3,
    "maxLength": 10
  }
}

修改 OpenAPI 规范后，将其重新导入 API 管理服务以应用更改。