在Azure API管理开发人员门户中，如何以友好格式显示openapi请求主体架构？

Question

我正试图通过上传我的OpenAPI2.0（nee.swagger）规范来发布一个带有Azure API管理的API（使用json API格式）。我想使用APIM的内置开发人员门户来提供文档，但在显示请求正文格式时遇到了一些障碍。

默认情况下，唯一可用的“表示”是“schema”和“sample”。示例很有用，但“schema”似乎只是显示“原始”响应模式，这并不像我希望的那样好。不幸的是，这似乎是在请求模式中显示字段“描述”的唯一方法。这并不理想，因为该描述包含有关某些字段的重要上下文。

理想情况下，我希望显示一个带有列的表，列标识字段、字段类型和openapi规范中的描述。我最初认为我可以编辑操作模板来解析和呈现模式中的信息，但它似乎是作为字符串传递到模板中的，而不是我可以索引到的对象。

有没有一种方法可以使用APIM开发人员门户以友好的方式呈现字段描述？

Schema Screensot（因为我还不允许发布图片：c）

Answer 1

可以按照您想要的方式呈现字段描述。为此，您必须在开发人员门户中自定义操作模板。这里有一个例子。请看这里的示例屏幕截图。它以表格格式呈现请求参数，而不是JSON格式的请求体。