两次指定相同的路径

Question

在一个由 Swagger-UI 呈现的 API 规范中，是否有可能多次出现相同的路径？

我应该创建单独的 api 规范并加载两个 Swagger-UI 实例吗？处理这个问题的最佳方法是什么？

例如。我有一个名为 /oauth/token 的端点，我想用一组参数记录 OAuth 授权代码流，并使用相同的端点 /oauth/token 文档记录 client_credentials 流的不同参数集。

/oauth/token:
    post:
      summary: token endpoint for authorization_code flow
      parameters:
        - name: code
          type: string
          description: Required for Authorization Code Flow
          in: formData
          required: true
        - name: grant_type
          type: string
          description: Grant Type should be specified as authorization_code
          in: formData
          required: true
          default: authorization_code
          enum:
          - authorization_code
          - client_credentials
        - name: client_id
          type: string
          description: Consumer Key
          in: formData
          required: true
        - name: client_secret
          type: string
          description: Consumer Secret
          in: formData
          required: true
        - name: endOtherSessions
          in: formData
          type: boolean
          required: false
          default: false
          description: Optional parameter. Default is false - do not allow concurrent login. Send true to end any other user sessions.
      tags:
        - OAuth2 Authorization Code

client_credentials 流的相同端点

/oauth/token2:
     post:
       summary: token for client credentials
       parameters:
         - name: grant_type
           type: string
           description: Grant Type should be specified as client_credentials
           in: formData
           required: true
           default: client_credentials
           enum:
          - authorization_code
          - client_credentials
         - name: client_id
           type: string
           description: Consumer Key
           in: formData
           required: true
         - name: client_secret
           type: string
           description: Consumer Secret
           in: formData
           required: true
       tags:
         - OAuth2 Client Credentials

Answer 1

由于问题是关于 OAuth2 而不是具有不同参数的单个端点，那么解决方案实际上是不同的。

Swagger 有一种特定的方式来记录授权方法，包括 4 种常见的 OAuth2 流程。

这些使用位于顶部Swagger object 的Security Definitions Object 进行描述。

您可以在其中定义一个或多个 OAuth2 流。规范本身为implicit 流程提供了一个示例，但其他规范遵循类似的结构。区别在于提供哪些字段，即authorizationUrl 和tokenUrl（取决于流类型）。

一旦你有了它，你就可以指定需要哪些安全方案。您可以在Swagger object 或Operation level 为所有操作指定它。

规范允许您定义一组安全方法是必需的，或者用户可以在给定的集合之间进行选择。