我正在尝试通过上传我的openapi 2.0(nee.wagger)规范来发布API(使用json-api格式化)和Azure API管理。我想使用APIM的内置开发人员门户来提供文档,但是我在显示请求体格式时遇到了一些麻烦。
默认情况下,唯一可用的“表示”是“架构”和“示例”。示例很有用,但“架构”似乎只显示“原始”响应架构,这不像我想的那样好1。不幸的是,这似乎是在请求模式中显示字段的“描述”的唯一方法。这并不理想,因为该描述包含有关某些领域的重要背景。
理想情况下,我想显示一个表格,其中的列标识了字段,类型以及openapi规范中的描述。我原本以为我能够编辑Operation模板来解析和呈现模式中的信息,但它似乎作为字符串传递给模板 - 而不是我可以索引的对象。
有没有办法用APIM Developer portal以“友好”的方式呈现字段描述?
Schema Screensot(因为我还不允许发布图片:c)
可以按照您想要的方式显示字段描述。为此,您必须在开发人员门户中自定义操作模板。 Here就是一个例子。看那里的示例截图。它以表格格式呈现请求参数,而不是JSON中的Request Body。