openapi 文档如何处理路径中的扩展答案

【问题标题】：openapi documentation how to handle extension in the pathopenapi 文档如何处理路径中的扩展
【发布时间】：2018-02-22 19:46:42
【问题描述】：

我有这样的网址：

/return/{pid}.xml?d1='123'&d2='345'
/return/{pid}.json?d1='123'&d2='345'

招摇规范要求：路径：/返回/{pid} ....

但是我怎样才能映射扩展ie

路径：/return/{pid}.xml

或

路径：/return/{pid}.json

这是一个 jersey+spring mvc 应用程序 - 所以两个 URL 都访问同一个控制器，并且仅基于扩展，其余框架将生成 xml / json 输出。

我不能忽略路径中的扩展，即：路径：/return/{pid}

因为用户需要知道他/她必须提供文件扩展名作为 URL 的一部分。此外，我不能使用对应于 xml / json 的两个路径，因为它们被应用程序视为相同。此外，它会重复一些事情（我不确定是否存在类似于 c++/java“switch”块中的“case”语句的机制）

【问题讨论】：

【解决方案1】：

在 Swagger 规范中，您可以在路径中定义文件扩展名，如下所示：

/return/{pId}.{fileExtension}

并在参数中定义文件扩展。

以下内容也有效（不适用于您的情况）：

/return/pid.{fileExtension}

【讨论】：