OpenAPI v3 能否在服务器URL级别定义HTTP请求方法?
在OpenAPI v3中定义根路径请求方法
当然可以定义仅使用服务器基础URL的请求方法,只需要把路径指定为/即可,这个路径对应服务器URL本身(也就是你要的https://api.example.com)。
具体写法如下:
servers: - url: https://api.example.com paths: /: # 根路径,对应服务器基础URL get: summary: 获取根路径资源 responses: '200': description: 成功响应 content: application/json: schema: type: object properties: message: type: string example: "欢迎访问API根路径"
这样定义后,GET https://api.example.com就是合法的请求,和你定义/users路径下的方法逻辑完全一致,只是路径层级不同。
需要注意的是,如果你的服务器URL末尾带有斜杠(比如https://api.example.com/),定义/路径仍然会正确匹配,OpenAPI规范会自动处理这种路径拼接的一致性问题。
内容的提问来源于stack exchange,提问作者Edgar Zuniga
相关产品推荐
相关产品推荐

