Api Watch Dog 项目使用教程

1. 项目目录结构及介绍

Api Watch Dog 是一个基于 Hyperf 框架的 Api 参数校验及 Swagger 文档生成组件。项目的主要目录结构如下：

.
├── composer.json            # Composer 配置文件
├── README.md                # 项目说明文件
├── gitattributes             # Git 属性配置文件
├── gitignore                # Git 忽略配置文件
├── phpstan.neon             # PHPStan 配置文件
├── phpunit.xml              # PHPUnit 配置文件
├── src                      # 源代码目录
│   ├── test                 # 测试目录
│   ├── ui/default           # 默认 UI 资源目录
│   ├── ...                  # 其他源代码文件
├── ...                      # 其他文件和目录

• composer.json：定义了项目的依赖和元数据。
• README.md：提供了项目的详细说明和基本使用方法。
• gitattributes 和 gitignore：配置 Git 的一些行为，例如忽略某些文件。
• phpstan.neon 和 phpunit.xml：分别用于配置静态代码分析工具 PHPStan 和单元测试框架 PHPUnit。
• src：存放源代码，包括测试代码、默认 UI 资源和其他源代码文件。

2. 项目的启动文件介绍

Api Watch Dog 组件的启动主要依赖于 Hyperf 框架的机制。在 Hyperf 中，通常不需要显式的启动文件，而是通过配置文件和注解来定义和启动服务。

当 Hyperf 应用启动时，会自动加载 composer.json 中定义的依赖，并根据 config/autoload 目录下的配置文件来初始化服务。

3. 项目的配置文件介绍

Api Watch Dog 的配置文件位于 config/autoload/apidog.php。以下是配置文件的基本结构和说明：

return [
    // 是否启用 Swagger 文档生成
    'enable' => env('APP_ENV') == 'production',
    
    // Swagger 文档的输出文件路径
    'output_file' => BASE_PATH . '/public/swagger/swagger.json',
    
    // 忽略的接口
    'ignore' => function ($controller, $action) {
        return false;
    },
    
    // 自定义验证器错误码、错误描述字段等
    'error_code' => 400,
    'http_status_code' => 400,
    'field_error_code' => 'code',
    'field_error_message' => 'message',
    'exception_enable' => false,
    
    // Swagger 的基础配置
    'swagger' => [
        'swagger' => '2.0',
        'info' => [
            'description' => 'hyperf swagger api desc',
            'version' => '1.0.0',
            'title' => 'HYPERF API DOC',
        ],
        'host' => 'apidog.cc',
        'schemes' => ['http'],
    ],
    
    // 响应模板配置
    'templates' => [
        // ...
    ],
    
    // 全局参数配置
    'global' => [
        // ...
    ],
];

这个配置文件定义了 Swagger 文档的生成开关、输出路径、忽略的接口、错误处理配置、Swagger 的基础信息和全局参数配置等。根据实际需要，开发者可以调整这些配置项以符合自己的项目要求。