NelmioApiDocBundle 中集成 JWT 认证路由文档的方法

背景介绍

NelmioApiDocBundle 是一个强大的 Symfony 文档生成工具，它能自动为 API 生成交互式文档。但在实际开发中，我们经常会遇到需要手动添加某些特殊路由文档的情况，特别是使用第三方认证包（如 lexik/jwt-authentication-bundle）时。

问题分析

lexik/jwt-authentication-bundle 提供了 JWT 认证功能，但它的路由（如登录检查路由）通常定义在配置文件中，不会自动出现在 NelmioApiDocBundle 生成的文档中。这会导致 API 文档不完整，缺少关键的认证接口说明。

解决方案

我们可以通过手动配置的方式将这些认证路由添加到 API 文档中。以下是具体实现方法：

1. 配置文档路径

在 config/packages/nelmio_api_doc.yaml 文件中，我们可以手动定义认证相关的路由文档。以 JWT 认证为例：

nelmio_api_doc:
    documentation:
        paths:
            /api/auth:
                post:
                    tags: [Authentication]
                    summary: 用户登录
                    description: 用户登录接口，返回 bearer token
                    operationId: login
                    requestBody:
                        content:
                            application/json:
                                schema:
                                    type: object
                                    required: [username, password]
                                    properties:
                                        username:
                                            type: string
                                            description: 用户名
                                        password:
                                            type: string
                                            format: password
                                            description: 密码
                                    example:
                                        username: 'johndoe'
                                        password: 'test'
                    responses:
                        '200':
                            description: 认证成功
                        '400':
                            description: 无效凭证
                        '401':
                            description: 未授权

2. 配置刷新令牌路由（可选）

如果需要支持令牌刷新功能，可以添加如下配置：

            /api/auth/refresh:
                post:
                    tags: [Authentication]
                    summary: 刷新令牌
                    operationId: refreshToken
                    requestBody:
                        content:
                            application/json:
                                schema:
                                    type: object
                                    required: [refresh_token]
                                    properties:
                                        refresh_token:
                                            type: string
                                            description: 刷新令牌
                                    example:
                                        refresh_token: 'xxx'
                    responses:
                        '200':
                            description: 成功
                        '401':
                            description: 未授权

注意事项

1. 确保配置中的路径与实际路由配置一致
2. 可以根据项目需求调整请求/响应参数和示例
3. 文档中的标签、描述等信息应该清晰准确，便于开发者理解
4. 对于生产环境，建议隐藏敏感信息的示例值

最佳实践

1. 将认证相关路由统一归类到"Authentication"标签下
2. 为每个接口提供详细的请求示例
3. 明确列出所有可能的响应状态码及其含义
4. 保持文档与实际接口行为一致

通过这种方式，我们可以确保 API 文档的完整性，让开发者能够清楚地了解如何使用认证接口，从而提高 API 的易用性。