在Swagger 2中对端点进行版本控制

时间:2017-12-14 04:28:58

标签: node.js rest swagger

我是Swagger的新手,我希望能够在需要时轻松创建新版本的端点。我的swagger.yaml文件看起来像这样:

swagger: "2.0"
info:
  version: "1.0.0"
  title: API
  description: blah
  contact:
    name: Some guy
basePath: /v1
schemes:
  - http
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  /log:
    x-swagger-router-controller: log
    post:
      summary: Creates a log entry.
      description: Creates a log entry.
      tags:
        - Logs
      security:
        - user: []
        - session: []
      parameters:
        - name: body
          in: body
          required: true
      responses:
        200:
          description: Success
        400:
          description: Error
        401:
          description: Unauthorized

我一直认为Swagger教程使用/ v1或/ v2等作为其基本路径。这有点问题......如何增加个人端点的版本?到目前为止,我所做的是创建基本路径/,然后在每个端点路径前加v1(例如v1/log)。虽然我有一个巨大的swagger.yaml文件,但这个解决方案并不能很好地扩展,因为我将拥有文件中每个端点的每个版本。更不用说,这也使文档变得混乱,因为每个端点都附有版本标识符。

Swagger 2有更简单或更好的方法吗?

0 个答案:

没有答案