swagger - OpenAPI 3 中的参数重用

Question

在 OpenAPI v3 中定义 API 时，如果多个 API 路径使用相同的查询参数列表，有没有办法定义一次并从每个路径引用它们？

想象一个常见的场景，我有 5 个不同的搜索 API，但它们都共享相同的查询参数，例如“限制、书签、页面、排序”等。

对可能重复的响应

我不是在询问一次引用 1 个特定参数，而是在多个 API 路径中重用一组参数。因此，我不认为它与如何在 OpenAPI 中定义全局参数？)

标签： swaggeropenapi

Answer 1

如果您希望将所有常用参数包含在 YAML 规范中的一行中，那么就规范本身而言，这似乎是不可能的。诸如 Springdoc（用于 Java）之类的框架提供了一个OperationCustomizer可以实现这些功能的接口。