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