L5-Swagger中实现同一状态码返回多种响应体的解决方案

在使用L5-Swagger进行API文档生成时，开发者经常会遇到需要为同一个HTTP状态码返回不同响应体的情况。本文将以400错误码为例，详细介绍如何在L5-Swagger中实现这一需求。

问题背景

在RESTful API设计中，有时我们需要为同一个HTTP状态码返回不同的响应体结构。例如，当客户端请求出现问题时，我们可能希望用400 Bad Request状态码返回多种不同的错误详情：

1. 授权信息为空的情况
2. 参数验证失败的情况
3. 其他业务逻辑错误的情况

每种情况都需要返回不同的错误代码(code)、消息(message)和详情(details)，但HTTP状态码都是400。

解决方案

L5-Swagger基于OpenAPI规范，我们可以利用OpenAPI的oneOf特性来实现这一需求。以下是具体的实现方式：

使用注解方式实现

use OpenApi\Attributes as OA;

#[OA\Get(
    // 其他路由配置...
    responses: [
        new OA\Response(
            response: 400,
            description: '错误响应',
            content: new OA\JsonContent(
                oneOf: [
                    new OA\Schema(
                        properties: [
                            new OA\Property(property: "code", type: "integer", example: 4001),
                            new OA\Property(property: "message", type: "string", example: "Bad request"),
                            new OA\Property(property: "details", type: "string", example: "Authorization empty"),
                        ]
                    ),
                    new OA\Schema(
                        properties: [
                            new OA\Property(property: "code", type: "integer", example: 4002),
                            new OA\Property(property: "message", type: "string", example: "Validation failed"),
                            new OA\Property(property: "details", type: "array", 
                                items: new OA\Items(type: "string", example: "The name field is required")
                            ),
                        ]
                    )
                ]
            )
        )
    ]
)]

使用注释方式实现

如果你更习惯使用注释方式，可以这样写：

/**
 * @OA\Response(
 *     response=400,
 *     description="错误响应",
 *     @OA\JsonContent(
 *         oneOf={
 *             @OA\Schema(
 *                 @OA\Property(property="code", type="integer", example=4001),
 *                 @OA\Property(property="message", type="string", example="Bad request"),
 *                 @OA\Property(property="details", type="string", example="Authorization empty"),
 *             ),
 *             @OA\Schema(
 *                 @OA\Property(property="code", type="integer", example=4002),
 *                 @OA\Property(property="message", type="string", example="Validation failed"),
 *                 @OA\Property(property="details", type="array", 
 *                     @OA\Items(type="string", example="The name field is required")
 *                 ),
 *             )
 *         }
 *     )
 * )
 */

最佳实践建议

1. 使用Schema引用：对于复杂的响应体，建议先在组件部分定义好Schema，然后在响应中引用它们，保持文档的整洁性。

2. 清晰的描述：为每种可能的响应提供清晰的描述，帮助API使用者理解不同场景下的返回结果。

3. 一致性设计：保持错误响应结构的一致性，例如始终包含code、message和details字段，只是内容不同。

4. 文档测试：生成文档后，务必进行测试，确保Swagger UI能正确显示所有可能的响应结构。

总结

通过使用OpenAPI的oneOf特性，我们可以在L5-Swagger中优雅地实现同一状态码返回多种响应体的需求。这种方法不仅保持了API设计的灵活性，还能生成清晰、准确的API文档，极大提升了API的可理解性和易用性。