我想使用 Swagger 定义以下路径:

/api/libraries/1234/books

并且 POST 一本书到图书馆的藏书,其 id 是 1234

在示例中,我在这里看到:https://github.com/swagger-api/swagger-spec/blob/master/examples/v2.0/json/petstore-with-external-docs.json

它显示,您可以指定例如: libraries/{id}/books ,但您必须将其定义为单独的路径对象。

例如,与 libraries 比较,用于 GET 目的;这将检索您的库列表。

有没有办法定义一个 sub path 对象(例如:在libraries 定义了一个 sub pathid ),在其下定义了一个 sub pathbooks ;也许 sub path 的另一个 employees

最佳答案

最简洁的答案是不。

根据 swagger 规范 2.0,不支持嵌套路径;您必须独立定义路径( https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#pathItemObject )。

然后,您可以使用 标签 对资源列表进行分组。

拥有原子路径的原因在于 Swagger 遵守 REST 规范。在 REST 中,资源链接到独立的原子操作(与 SOAP/RPC 不同)。

关于rest - 如何使用 Swagger 参数化 POST 的 URL?,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/31507505/

10-16 04:17