在 Swagger 中处理认证授权通常需要使用 OpenAPI 规范中的 securityDefinitions 字段来定义安全模式,并在 API 操作上使用 security 字段指定需要的安全模式。
下面是一个示例,演示如何在 Swagger 中处理基本身份验证认证授权:
- 首先,在 Swagger 文档中定义 securityDefinitions,指定使用 basic 认证方式:
securityDefinitions: basicAuth: type: basic
- 接着,在 API 操作上使用 security 字段指定需要的安全模式:
paths: /api/endpoint: get: security: - basicAuth: [] responses: 200: description: Successful operation
这样,在 Swagger UI 中就会显示一个认证框,用户需要输入用户名和密码才能访问该 API 操作。
除了基本身份验证,Swagger 还支持其他认证方式,如 OAuth 2.0、API Key 等。你可以根据实际需要在 securityDefinitions 中定义相应的安全模式,并在 API 操作上使用 security 字段指定需要的安全模式。