如何设置 OpenAPI 重定向带有参数的响应？

Question

我有一个 HTTP 302（重定向），我实现了一个新的状态参数，该参数将附加到RedirectURL，因此可以显示类似的消息

如果调用 URL 传递为

GET http://localhost:8080/info/status?redirectUrl=http://localhost:8080/redirect

然后它会重定向为

GET http://localhost:8080/info/status?redirectUrl=http://localhost:8080/redirect

它是对应的

http://localhost:8080/redirect?status=success

但是 OpenAPI 规范中如何描述这一点呢？parameters我似乎无法在响应中使用，并找到了一些使用的代码responseParameters，但我没有运气让它工作......甚至不知道它是否受支持，至少，我没有编译错误与这两个命令

http://localhost:8080/redirect?status=error

出现这种情况的常见方式是什么？

我们应该有 2 个重定向 URL，例如

GET http://localhost:8080/info/status
   ?redirectUrl=http://localhost:8080/redirect
   &errorUrl=http://localhost:8080/redirect_error

我对这个简单的困境有点茫然，也许有人可以帮助

Answer 1

是的，这是 OpenAPI 的一个恼人的问题。您实际上无法显式指定重定向。

您能做的最好的事情就是指定一个响应，其状态代码位于 3xx 重定向范围（301、302、303、307、308）中，该响应具有“string”类型的“location”标头参数。

然后您应该添加描述和摘要 - 几乎您已经完成了。

希望尽快有所作为。