Swagger 可以将不同请求路径的 API 接口写在同一个文件中,也可以将其分别写在不同的文件中。

如果你想将不同请求路径的 API 接口写在同一个文件中,可以使用 Swagger 的路径参数来区分不同的请求路径。例如,你可以在 Swagger 中定义一个 GET 请求的路径参数,如下所示:

'/users/{userId}'

这个路径参数可以匹配所有以 '/users/' 开头的请求路径,其中的 '{userId}' 表示这个参数可以在请求路径中动态地替换成实际的用户 ID。然后,你可以在同一个 Swagger 文件中定义多个这样的路径参数,来实现不同请求路径的 API 接口。

如果你想将不同请求路径的 API 接口写在不同的文件中,可以使用 Swagger 的文件引用功能。首先,你需要将不同请求路径的 API 接口分别写在不同的 Swagger 文件中,并在这些文件中定义好它们的请求路径和参数。然后,在主 Swagger 文件中,你可以使用 $ref 关键字来引用这些文件中的 API 接口定义,如下所示:

paths:
  /users:
    $ref: './users.yaml#/paths/users'
  /products:
    $ref: './products.yaml#/paths/products'

这样,Swagger 就可以将这些不同请求路径的 API 接口自动合并成一个完整的 API 文档。


原文地址: https://www.cveoy.top/t/topic/lEww 著作权归作者所有。请勿转载和采集!

免费AI点我,无需注册和登录