Api Watch Dog：Hyperf框架下的API参数校验与Swagger文档生成利器

项目介绍

在现代Web开发中，API的参数校验和文档生成是不可或缺的环节。为了简化这一过程，我们推出了Api Watch Dog，这是一个专为Hyperf框架设计的组件，旨在通过注解实现API参数的自动校验，并自动生成Swagger文档。这不仅使业务代码更加纯粹，还大大减轻了接口文档维护的负担。

项目技术分析

Api Watch Dog的核心功能包括：

1. 自动参数校验：通过中间件拦截HTTP请求，根据注解中的参数定义，使用validation自动验证和过滤参数。如果验证失败，请求将被拦截并返回错误信息。
2. Swagger文档生成：在php bin/hyperf.php start启动http-server时，通过监听BootAppConfListener事件，扫描控制器注解，自动组装swagger.json结构，并输出到配置文件定义的路径中。

项目及技术应用场景

Api Watch Dog适用于以下场景：

• API开发：在开发RESTful API时，自动校验请求参数，确保数据的有效性。
• 文档维护：自动生成Swagger文档，减少手动维护文档的工作量，提高开发效率。
• 多版本API管理：支持不同版本的API管理，通过注解轻松实现版本控制。

项目特点

1. 注解驱动：通过注解定义API参数和文档，使代码更加简洁和直观。
2. 自动校验：内置强大的参数校验机制，支持自定义校验规则和控制器回调校验。
3. Swagger集成：自动生成Swagger文档，支持多种配置选项，方便文档的展示和维护。
4. 多版本支持：通过ApiVersion注解，轻松管理不同版本的API。
5. 灵活配置：提供丰富的配置选项，满足不同项目的需求。

使用指南

安装

composer require daodao97/apidog

配置

1. 发布配置文件：

php bin/hyperf.php vendor:publish daodao97/apidog
php bin/hyperf.php vendor:publish hyperf/translation
php bin/hyperf.php vendor:publish hyperf/validation

2. 修改配置文件：

根据需求修改config/autoload/apidog.php，配置文件结构优化，支持Swagger外的整体配置。

启用中间件

在config/autoload/middlewares.php中启用ApiValidationMiddleware。

校验规则定义

参考hyperf/validation文档和laravel/validation文档，支持自定义校验和控制器回调校验。

样例代码

以下是一个简单的使用样例，展示了如何通过注解定义API参数和响应：

/**
 * @ApiVersion(version="v1")
 * @ApiController(tag="demo管理", description="demo的新增/修改/删除接口")
 */
class DemoController extends AuthController
{
    /**
     * @PostApi(path="/demo", description="添加一个用户")
     * @Header(key="token|接口访问凭证", rule="required")
     * @FormData(key="a.name|名称", rule="required|max:10|cb_checkName")
     * @ApiResponse(code="0", description="请求成功", schema={"id":"1"})
     */
    public function add()
    {
        return [
            'code'   => 0,
            'id'     => 1,
            'params' => $this->request->post(),
        ];
    }
}

Swagger UI启动

Api Watch Dog提供了两种方式启动Swagger UI：

1. 自动输出：系统启动时，swagger.json会自动输出到配置文件中定义的output_file中。
2. 快捷命令：使用组件提供的快捷命令，快速启动一个Swagger UI。

php bin/hyperf.php apidog:ui
php bin/hyperf.php apidog:ui --port 8888

结语

Api Watch Dog通过自动化和注解驱动的特性，极大地简化了API参数校验和文档生成的过程。无论你是正在开发一个新的API项目，还是希望优化现有的API管理流程，Api Watch Dog都能为你提供强大的支持。立即尝试，体验高效开发的乐趣吧！