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

Question

我有URL喜欢：

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

swagger 规范要求：路径：/return/{pid} ....

但是我如何映射扩展名 ie

路径：/return/{pid}.xml

或

路径：/return/{pid}.json

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

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

因为用户需要知道 he/she 必须提供文件扩展名作为 URL 的一部分。此外，我不能使用对应于 xml / json 的两条路径，因为应用程序对它们的处理方式相同。此外，它还会重复一些事情（我不确定是否有类似 "case" statements in c++/java "switch" block 的 fall-through like 机制）

Answer 1

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

/return/{pId}.{fileExtension}

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

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

/return/pid.{fileExtension}

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

openapi documentation how to handle extension in the path

swagger-2.0

openapi