仅在查询参数名称上不同的路径

Question

我正在使用swagger编辑器记录一个现有的API，该API允许一个路径支持两个不同的请求，这两个请求仅在查询参数名上有所不同。例如：

swagger: '2.0'
info:
  title: example
  version: 1.0.0
host: example.com
schemes:
  - http
basePath: /WS
paths:
  /Login:
    post:
      summary: Login
      description: |
        Log in
      parameters:
        - name: UserID
          in: query
          description: User ID
          required: true
          type: string
        - name: Password
          in: query
          description: User password
          required: true
          type: string
      responses:
        '200':
          description: Success
  /Login:
    post:
      summary: Login
      description: |
        Log in
      parameters:
        - name: UserID
          in: query
          description: User ID
          required: true
          type: string
        - name: Token
          in: query
          description: Authentication token
          required: true
          type: string
      responses:
        '200':
          description: Success

这里我支持对http://example.com/ws/login？userid=foo&passoword=bar和http://example.com/ws/login？userid=foo&token=dubdu22r8dwjg767dg的请求。

swagger编辑器不会显示上述yaml的任何错误，但它只为第二个路径（具有UserId和令牌queryparams的路径）生成文档，而不是同时生成。有人能指出我哪里出了问题吗？谢了。

编辑：

如果我将第二个/login:路径更改为（例如）/login1:，那么我会在文档中看到这两个路径。但不是解决办法。

Answer 1

您可以改为使用路径参数，请尝试：

swagger: '2.0'
info:
  title: example
  version: 1.0.0
host: example.com
schemes:
  - http
basePath: /WS
paths:
  /Login?UserID={id}&Password={password}:
    post:
      summary: Login
      description: Log in
      parameters:
        - name: id
          in: path
          description: User ID
          required: true
          type: string
        - name: password
          in: path
          description: User password
          required: true
          type: string
      responses:
        '200':
          description: Success
  /Login?UserID={id}&Token={token}:
    post:
      summary: Login
      description: Log in
      parameters:
        - name: id
          in: path
          description: User ID
          required: true
          type: string
        - name: token
          in: path
          description: Authentication token
          required: true
          type: string
      responses:
        '200':
          description: Success