PHPackages                             kakuilan/hyperf-apihelper - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. kakuilan/hyperf-apihelper

ActiveLibrary[API Development](/categories/api)

kakuilan/hyperf-apihelper
=========================

hyperf api swagger helper

0.5.9(4y ago)443.0k12[5 issues](https://github.com/kakuilan/hyperf-apihelper/issues)Apache-2.0PHPPHP >=7.2

Since Jan 20Pushed 4y ago3 watchersCompare

[ Source](https://github.com/kakuilan/hyperf-apihelper)[ Packagist](https://packagist.org/packages/kakuilan/hyperf-apihelper)[ RSS](/packages/kakuilan-hyperf-apihelper/feed)WikiDiscussions master Synced today

READMEChangelog (10)Dependencies (15)Versions (60)Used By (0)

hyperf-apihelper
================

[](#hyperf-apihelper)

hyperf api and swagger helper.
它是一个[Hyperf](https://github.com/hyperf/hyperf)框架的 \[**api接口自动验证和swagger接口文档生成**\] 组件.
功能包括：

- 通过注解定义接口路由、请求方法和参数,并由中间件自动校验接口参数.
- 生成json文件,供swagger接口文档测试使用,可打开或关闭.
- swagger支持接口多版本分组管理.
- 支持restful path路由参数校验.
- 支持自定义响应体结构.
- 支持自定义多层级swagger model.
- 支持自定义前置动作.
- 支持自定义拦截动作.
- 支持自定义后置动作.

支持：

- php 7.2~7.4,8.0
- hyperf 1.1/2.1/2.2

不支持：

- php8注解

### !!注意

[](#注意)

***旧版本升级到v0.5.7时,须手动将`public/swagger/index.html`重命名为`template.html`***

### 0.安装

[](#0安装)

- nginx(或apache)指定站点目录为 BASE\_PATH/public, swagger-ui将自动发布到该目录下
- 安装组件

```
# composer安装本组件
composer require kakuilan/hyperf-apihelper

# 发布组件初始化配置文件到你的项目下
php bin/hyperf.php vendor:publish kakuilan/hyperf-apihelper
```

### 1.配置

[](#1配置)

- 修改config/autoload/apihelper.php中的配置,将`host`改为你的域名(如test.com),则接口文档地址为test.com/swagger
- 修改config/autoload/middlewares.php中间件配置,如

```
return [
    'http' => [
        Hyperf\Apihelper\Middleware\ApiValidationMiddleware::class,
    ],
];
```

- 修改config/autoload/exceptions.php异常处理配置,如

```
return [
    'handler' => [
        'http' => [
            Hyperf\HttpServer\Exception\Handler\HttpExceptionHandler::class,
            Hyperf\Apihelper\Exception\Handler\ValidationExceptionHandler::class,
            App\Exception\Handler\AppExceptionHandler::class,
        ],
    ],
];
```

- 修改config/autoload/dependencies.php依赖配置,如

```
return [
    Hyperf\HttpServer\Router\DispatcherFactory::class => Hyperf\Apihelper\DispatcherFactory::class
];
```

### 2.使用示例

[](#2使用示例)

编辑控制器文件app/Controller/Test.php,如

```
namespace App\Controller;

use Hyperf\Apihelper\Annotation\ApiController;
use Hyperf\Apihelper\Annotation\ApiResponse;
use Hyperf\Apihelper\Annotation\ApiVersion;
use Hyperf\Apihelper\Annotation\Method\Delete;
use Hyperf\Apihelper\Annotation\Method\Get;
use Hyperf\Apihelper\Annotation\Method\Patch;
use Hyperf\Apihelper\Annotation\Method\Post;
use Hyperf\Apihelper\Annotation\Method\Put;
use Hyperf\Apihelper\Annotation\Param\Body;
use Hyperf\Apihelper\Annotation\Param\File;
use Hyperf\Apihelper\Annotation\Param\Form;
use Hyperf\Apihelper\Annotation\Param\Header;
use Hyperf\Apihelper\Annotation\Param\Path;
use Hyperf\Apihelper\Annotation\Param\Query;
use Hyperf\Apihelper\Controller\BaseController;
use Hyperf\Apihelper\Exception\ValidationException;

/**
 * @ApiController(tag="测试实例", prefix="/hello", description="测试例子")
 * @ApiVersion(group="v1", description="第一版本")
 */
class Test extends BaseController {

    /**
     * @Get(path="/user", summary="接口摘要", description="获取用户详情")
     * @Query(key="id", rule="required|int|gt:0", example="5")
     * @Query(key="u", rule="required|active_url|trim", example="http://baidu.com")
     * @Query(key="t", rule="required|starts_with:a")
     * @Query(key="e", rule="required|trim|enum:e,f,g")
     * @Query(key="h", rule="trim|cb_chkHello")
     * @ApiResponse(code=200, schema={"$ref":"Response"})
     */
    public function get() {
        //失败
        //return self::doFail();

        //成功
        return self::doSuccess();
    }

    /**
     * @Patch(path="/info/{id}", description="路由参数测试")
     * @Path(key="id", rule="int|gt:0")
     * @ApiResponse(code=200, schema={"$ref":"Response"})
     */
    public function info() {
        $data = [
            'id' => $this->request->route('id'),
        ];
        return self::doSuccess($data);
    }

    /**
     * 检查输入字段
     * @param mixed $value 字段值
     * @param string $field 字段名
     * @param array $options 参数选项
     * @return array
     */
    public function chkHello($value, string $field, array $options): array {
        $res = [
            true,
            $value,
        ];
        if (!true) {
            $res = [
                false,
                '具体验证失败的信息',
            ];
        }

        return $res;
    }

    /**
     * @Get(description="生成验证码")
     * @Header(key="authorization|访问令牌", rule="required_without_all:access_token")
     * @Query(key="access_token|访问令牌", rule="required_without_all:authorization")
     * @Query(key="len|验证码长度", rule="int|gt:0|max:10|default:6")
     * @Query(key="type|验证码类型", rule="int|default:0|enum:0,1,2,3,4,5")
     * @Query(key="width|图片宽度", rule="int|gt:1|default:100")
     * @Query(key="height|图片高度", rule="int|gt:1|default:30")
     * @ApiResponse(code=200, schema={"$ref":"Response"})
     */
    public function create() {
        $len    = $this->request->query('len');
        $type   = $this->request->query('type');
        $width  = $this->request->query('width');
        $height = $this->request->query('height');

        return self::doSuccess();
    }

    /**
     * @Post(path="/arrparam", description="数组形式参数/多级参数")
     * @Form(key="arr", rule="required|array")
     * @Form(key="row", rule="object")
     * @Form(key="row.name", rule="required|string|trim")
     * @Form(key="row.age", rule="int|gt:0|default:1")
     * @Form(key="row.addr", rule="string|trim")
     * @ApiResponse(code=200, schema={"$ref":"Response"})
     */
    public function arrparam() {
        $post = $this->request->post();
        return self::doSuccess($post);
    }

    /**
     * @Post(path="/test/testbody", description="body测试")
     * @Body(rule="required|json|cb_parseBody")
     * @ApiResponse(code=200, schema={"$ref":"Response"})
     */
    public function testbody() {
        return self::doSuccess(date('Y-m-d H:i:s'));
    }

    /**
     * 自定义解析body数据
     * @param mixed $value 字段值
     * @param string $field 字段名
     * @param array $options 参数选项
     * @return array
     * @throws ValidationException
     */
    public function parseBody($value, string $field, array $options): array {
        $arr = json_decode($value, true);
        $res = [
            true,
            $value,
        ];

        //自行检查
        if (!isset($arr['hello'])) {
            $res = [
                false,
                'body必须包含hello字段',
            ];
            return $res;
        }

        //或者
        if (!isset($arr['world'])) {
            throw new ValidationException('body必须包含world字段');
        }

        return $res;
    }

    /**
     * @Post(path="/test/upload", description="上传测试")
     * @File(key="sec", rule="required|file|size:1000")
     * @File(key="img", rule="file|image")
     * @ApiResponse(code=200, schema={"$ref":"Response"})
     */
    public function upload() {
        $files = $this->request->getUploadedFiles();
        return self::doSuccess($files);
    }

    /**
     * 获取模型结构-结构名 Hello,为一般数据模型
     * @return array
     */
    public static function getSchemaHello(): array {
        return [
            'a' => false,
            'b' => 2,
            'c' => 'hello',
            'p' => '$Person',
        ];
    }

    /**
     * 获取模型结构-结构名 SayHello,为接口响应模型
     * @return array
     */
    public static function getSchemaSayHello(): array {
        //接口响应模型的外层结构,必须和Response基本响应体一致
        $res         = self::getSchemaResponse();
        $res['data'] = '$Hello';

        return $res;
    }

    /**
     * @Get(path="/test/sayhello", description="自定义响应模型-SayHello")
     * @ApiResponse(code=200, schema={"$ref":"SayHello"})
     */
    public function sayhello() {
        //这里仅做测试例子,实际数据应根据你自己的应用去处理
        $data = self::getDefaultDataBySchemaName('SayHello');
        return self::doSuccess($data);
    }

    /**
     * @Get(path="/test/persons", description="自定义响应模型-人员列表")
     * @ApiResponse(code=200, schema={"$ref":"TestPersons"})
     */
    public function persons() {
        $data = self::getDefaultDataBySchemaName('Persons');
        return self::doSuccess($data);
    }

    /**
     * @Get(path="/test/company", description="自定义响应模型-单个公司")
     * @ApiResponse(code=200, schema={"$ref":"TestCompany"})
     */
    public function company() {
        $data = self::getDefaultDataBySchemaName('Company');
        return self::doSuccess($data);
    }

    /**
     * @Get(path="/test/company2", description="简化响应体模型引用，其中refKey指定schema中的字段名，refValue为该字段要引用的模型名称")
     * @ApiResponse(code=200, schema={"$ref":"Response"}, refKey="data", refValue="Company")
     */
    public function company2() {
        $data = self::getDefaultDataBySchemaName('Company');
        return self::doSuccess($data);
    }

    /**
     * @Get(path="/test/company3", description="简化响应体模型引用，refKey可以不写，默认为data字段")
     * @ApiResponse(code=200, schema={"$ref":"Response"}, refValue="Company")
     */
    public function company3() {
        $data = self::getDefaultDataBySchemaName('Company');
        return self::doSuccess($data);
    }

}
```

### 3.验证规则

[](#3验证规则)

- 本组件会在hyperf启动时提前扫描规则,相比在运行时每次请求都扫描,性能有所提升
- 组件会先执行Hyperf官方规则,详见[hyperf validation](https://hyperf.wiki/#/zh-cn/validation)
- 再执行本组件的验证规则,包括:
    - 转换器,有

        - default,若未传该参数,或传空字符串时,将参数值设为指定的默认值
        - int/integer,将非null参数值转换为整型.注意:若未传该参数,且未设默认值时,为null.
        - float,将非null参数值转换为浮点数.注意:若未传该参数,且未设默认值时,为null.
        - bool,将非null参数值转换为布尔型.注意:若未传该参数,且未设默认值时,为null.其中字符串:
            - 'false', 'null', 'nil', 'none', '0', '0.0' 将转换为`false`
            - 'true', '1' 将转换为`true`
        - trim,过滤参数值前后空格
    - 扩展规则,有

        - enum,检查参数值是否枚举值中的一个
        - natural,检查是否自然数
        - cnmobile,检查是否中国手机号
        - cncreditno,检查是否中国身份证号
        - safe\_password,检查是否安全密码
    - 控制器验证方法.
        若需要在控制器中执行比较复杂的逻辑去验证,则可以使用该方式.
        如上例中的cb\_chkHello,规则名以`cb_`开头,后跟控制器的方法名chkHello.
        验证方法必须定义接受3个参数:$value, $field, $options;
        返回结果必须是一个数组:
        若检查失败,为\[false, 'error msg'\];若检查通过,为\[true, $newValue\],$newValue为参数值的新值.
        形如:

        ```
        public function fn($value, string $field, array $options): array
        ```

### 4.接口响应体

[](#4接口响应体)

- #### 4.1 默认响应体结构

    [](#41-默认响应体结构)

    - 接口操作成功,返回{"status":true,"msg":"success","code":200,"data":\[\]}
    - 接口操作失败,返回{"status":false,"msg":"fail","code":400,"data":\[\]}
    - 自定义响应错误码code,可参考languages/zh\_CN/apihelper.php
- #### 4.2 自定义响应体结构

    [](#42-自定义响应体结构)

    若要自定义响应体结构,可以

    - 首先修改config/autoload/apihelper.php中的base\_controller配置,指定基本控制器,如

    ```
    'base_controller' => Hyperf\Apihelper\Controller\BaseController::class,
    ```

    - 然后基本控制器需要实现`Hyperf\Apihelper\Controller\ControllerInterface`接口.
        包括以下几个静态方法:

        - `getSchemaResponse(): array`,获取响应体结构,对应模型名称`Response`
        - `doSuccess($data = [], string $msg = 'success', array $result = []): array`,操作成功时响应
        - `doFail($code = '400', array $trans = []): array`,操作失败时响应
        - `doValidationFail(string $msg = ''): array`,执行验证失败时响应
    - 最后,基本控制器作为控制器的父类,所有的控制器必须继承自该类.
        具体可参考`Hyperf\Apihelper\Controller\BaseController`.
- #### 4.3 自定义多层级swagger model

    [](#43-自定义多层级swagger-model)

    对接口响应的swagger结构模型生成,使用注解,如

    ```
    @ApiResponse(code=200, schema={"$ref":"Response"})
    ```

    其中`Response`为接口响应基本模型,由`getSchemaResponse()`方法定义.其他自定义接口响应模型的最外层结构,必须和它相同;非接口响应的一般数据模型,则无此要求.
    这里说的"接口响应模型",是指使用@ApiResponse注解的、直接由接口输出的结构模型.
    由于应用业务输出数据的多样性,本组件也支持自定义、多层级的模型,按如下规则:

    - 在控制器中使用`getSchema`为前缀,后跟驼峰规则的结构模型名称,组成的公共静态方法,形如

    ```
    public static function getSchemaAbcXyz(): array
    ```

    - 则AbcXyz就是上述方法定义的模型名称,该方法必须返回一个数组,体现该模型的数据结构.
    - 若要在模型中引用另外一个模型,可以使用$符号来引用,进而实现模型间的嵌套,如

    ```
      // 先定义一个基本的数据模型结构
      public static function getSchemaPerson(): array {
          return [
              'name'   => 'zhang3',
              'age'    => 24,
              'weight' => 64.5,
              'addr'   => 'home',
              'male'   => true,
          ];
      }

      // 再使用$前缀引用其他结构,首字母大小写都可以(但建议大写),组件将会自动转换为首字母大写的驼峰名称.
      public static function getSchemaPersons(): array {
          return [
              '$person',
              '$Person',
              '$Person',
          ];
      }
    ```

    - 因此,$符号在自定义模型中是关键字,要谨慎使用.
    - 为了维护方便,建议所有的自定义模型都在同一个父级控制器中定义.本组件在`SchemaModel`中定义.若你在不同控制器中定义不同或相同的模型,也是允许的.不过要注意,因为模型名称是唯一的,本组件仅会使用最先扫描到的模型定义.
    - 为了测试,本组件内置的模型有如下几个,你自定义的模型名称应避免和它们相同:
        `Response`,`Person`,`Persons`,`Department`,`Company`,`TestPersons`,`TestCompany`
    - 强调下,自定义swagger模型和自定义响应体结构两者是不同的;swagger模型只是描述API接口文档的,而响应体结构则是接口的输出结果;若接口文档和接口输出有差异,则你应该要检查接口输出逻辑.
    - 具体可参考[2.使用示例](#2%E4%BD%BF%E7%94%A8%E7%A4%BA%E4%BE%8B)的自定义响应模型部分代码,以及`Hyperf\Apihelper\Controller\SchemaModel`
- #### 4.4 简化响应体模型引用

    [](#44-简化响应体模型引用)

    通常响应体的最外层基本结构是固定的,变化的只是里面的数据字段.
    为了避免如`SchemaModel::getSchemaTestPersons()`、`SchemaModel::getSchemaTestCompany()`等重复的响应体定义工作,ApiResponse注解类提供了字段引用功能.例如:

    ```
    @ApiResponse(code=200, schema={"$ref":"Response"}, refKey="data", refValue="Company")
    ```

    其中`refKey`指定schema响应体中的字段名,可以不写,默认为data;`refValue`为该字段要引用的数据模型名称.
    当refKey和refValue都不为空,且refValue指定的模型已经定义时,该接口的基本响应体还是Response,只是它的data字段引用了Company模型.
    具体可参考[2.使用示例](#2%E4%BD%BF%E7%94%A8%E7%A4%BA%E4%BE%8B)的简化响应体模型引用部分代码

### 5.自定义前置动作、拦截动作和后置动作

[](#5自定义前置动作拦截动作和后置动作)

- #### 5.1 前置动作

    [](#51-前置动作)

    可以自定义控制器前置方法,每次在具体动作之前执行.
    该功能主要是数据初始化,将自定义的数据存储到request属性中,每次请求后销毁,避免控制器协程间的数据混淆.
    该方法必须严格定义，形如:

    ```
    public function fn(ServerRequestInterface $request): ServerRequestInterface
    ```

    该方法不会中止后续具体动作的执行.
    方法名可以在config/autoload/apihelper.php中的`controller_antecedent`指定,默认为`initialization`
    具体可参考`Hyperf\Apihelper\Controller\BaseController`.
- #### 5.2 拦截动作

    [](#52-拦截动作)

    可以自定义控制器拦截方法,每次在具体动作之前执行.
    该功能主要是执行逻辑检查(如令牌或权限),当不符合要求时,中止后续具体动作的执行.
    该方法必须严格定义,形如:

    ```
    public function fn(string $controller, string $action, string $route): mixed
    ```

    若该方法返回非空的数组或字符串,则停止执行后续的具体动作.
    方法名可以在config/autoload/apihelper.php中的`controller_intercept`指定,默认为`interceptor`
    具体可参考`Hyperf\Apihelper\Controller\BaseController`.
- #### 5.3 后置动作

    [](#53-后置动作)

    可以自定义控制器后置方法,每次在具体动作之后执行,无论是否执行了拦截方法.
    该功能主要是做一些日志收集和数据统计等.
    该方法必须严格定义,形如:

    ```
    public function fn(ServerRequestInterface $request, ResponseInterface $response): void
    ```

    方法名可以在config/autoload/apihelper.php中的`controller_subsequent`指定,默认为`after`
    注意:

    - *请不要在方法中对$request和$response这两个对象做修改*
    - *而仅是使用它们的方法去获取相应的属性值*

    具体可参考`Hyperf\Apihelper\Controller\BaseController`.

### 6.接口多版本分组

[](#6接口多版本分组)

针对接口多版本分组的功能,一般的做法是将控制器划分多个命名空间,如`V1.0`、`V2.0`等.
本组件提供了`ApiVersion`注解,它可以方便地为控制器绑定一个或多个版本号.
*注意*:

- 该功能默认将影响绑定的路由,会自动在已定义的路由前面加上版本号前缀,实际的路径将改变.
- 若你希望不影响已绑定的路由,可将配置`use_version_path`修改为`false`
- 版本分组名称,只能由英文、数字和下划线组成.
    当一个控制器里面的接口功能在多次迭代中保持不变时,就可以绑定多个版本号,例如:

```
/**
 * @ApiController(tag="测试实例", description="测试例子")
 * @ApiVersion(group="v1", description="第一版本")
 * @ApiVersion(group="v2", description="第二版本")
 * @ApiVersion(group="v3", description="第三版本")
 */
class Test extends BaseController {}
```

### 7.校验提示和数据获取

[](#7校验提示和数据获取)

- #### 7.1 校验参数提示

    [](#71-校验参数提示)

    - 配置开发环境提示具体参数错误
        编辑apihelper.php配置,将`show_params_detail_error`设为`true`,
        接口将显示具体字段验证规则的错误信息,方便前端调试.
    - 配置生产环境不提示具体参数错误
        编辑apihelper.php配置,将`show_params_detail_error`设为`false`,
        接口将隐藏具体字段验证信息,而仅提示"缺少必要的参数,或参数类型错误",减少外部安全攻击的可能.
- #### 7.2 获取验证完的数据

    [](#72-获取验证完的数据)

    要获取具体参数,在控制器里面直接使用hyperf官方的方法去获取,如

    ```
    $this->request->header('user-agent');
    $this->request->query('len');
    $this->request->post();
    $this->request->route('id');
    $this->request->getUploadedFiles();
    $this->request->getBody()->getContents();
    ```

    **注意:所有的参数都已经过校验处理,不再是原始的数据.**
    若校验规则中包含有转换器,接收参数后,已经自动转换,无需再手工转换一次.如

    - 校验规则中有trim,则' hello '会自动转为'hello'.
    - 校验规则中有int,则字符串'123'会自动转为整型123.

### 8.swagger生成

[](#8swagger生成)

1. api请求方法定义包括 `Get`, `Post`, `Put`, `Patch`, `Delete`
2. 参数定义包括 `Header`, `Query`, `File`, `Form`, `Body`, `Path`
3. 返回结果定义 `ApiResponse` ,json串,如{"status":true,"msg":"success","code":200,"data":\[\]}
4. 生产环境请将配置`output_json`修改为false,关闭swagger.
5. 字段值举例,使用`example`指定.注意:举例值应和字段类型一致.如

```
@Query(key="id", rule="required|int|gt:0", example="5")

```

### 9.升级注意

[](#9升级注意)

- #### v0.1.7升级:

    [](#v017升级)

    - config/autoload/apihelper.php的api新增配置项
        `'base_controller' => \Hyperf\Apihelper\Controller\BaseController::class`
    - 基本控制器Hyperf\\Apihelper\\BaseController已删除,将其替换为Hyperf\\Apihelper\\Controller\\BaseController
    - ApiResponse::doSuccess方法已删除,替换为BaseController::doSuccess,或self::doSuccess
    - ApiResponse::doFail方法已删除,替换为BaseController::doFail,或self::doFail
- #### v0.2.4升级:

    [](#v024升级)

    - `ControllerInterface::getResponseSchema`已改为`ControllerInterface::getSchemaResponse`
    - `BaseController::getResponseSchema`已改为`BaseController::getSchemaResponse`
    - 将你代码中引用到的`getResponseSchema`修改为`getSchemaResponse`
- #### v0.3.5升级:

    [](#v035升级)

    - 从v0.3.5起,接口多版本分组功能,默认会自动在路由前加上版本号前缀,实际路径将发生改变.
    - 若你希望不影响已绑定的路由,可将配置`use_version_path`修改为`false`
- #### v0.5.7升级:

    [](#v057升级)

    - 旧版本升级到v0.5.7时,须手动将`public/swagger/index.html`重命名为`template.html`

### 10. 其他注意事项

[](#10-其他注意事项)

- Hyperf框架自有的AutoController(或Controller)和本组件的ApiController注解不能同时使用,否则会引起路由混乱.
    下面是错误的示例: ```
    /**
    * @AutoController()
    * @ApiController()
    */
    class Test extends BaseController {}
    ```

    下面是正确的示例: ```
    /**
    * @AutoController()
    */
    class Test extends BaseController {}
    ```

    或 ```
    /**
    * @ApiController()
    */
    class Test extends BaseController {}
    ```

### 11. 图例

[](#11-图例)

[![api多版本](tests/01.jpg)](tests/01.jpg)

[![jwt](tests/02.jpg)](tests/02.jpg)

[![jwt](tests/03.jpg)](tests/03.jpg)

[![default](tests/04.jpg)](tests/04.jpg)

[![array](tests/05.jpg)](tests/05.jpg)

[![model](tests/06.jpg)](tests/06.jpg)

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance18

Infrequent updates — may be unmaintained

Popularity30

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 98.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~12 days

Recently: every ~46 days

Total

59

Last Release

1626d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/052d0d8bf5c8db8e96d017460096cdd289564ec54b0268b39b45cbbf958ab8ee?d=identicon)[kakuilan](/maintainers/kakuilan)

---

Top Contributors

[![kakuilan](https://avatars.githubusercontent.com/u/2321437?v=4)](https://github.com/kakuilan "kakuilan (160 commits)")[![Reasno](https://avatars.githubusercontent.com/u/3881629?v=4)](https://github.com/Reasno "Reasno (2 commits)")

---

Tags

phpapiswaggerhyperfapi swagger

###  Code Quality

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/kakuilan-hyperf-apihelper/health.svg)

```
[![Health](https://phpackages.com/badges/kakuilan-hyperf-apihelper/health.svg)](https://phpackages.com/packages/kakuilan-hyperf-apihelper)
```

###  Alternatives

[daodao97/apidog

A swagger library for Hyperf.

14940.9k1](/packages/daodao97-apidog)[hyperf/swagger

A swagger library for Hyperf.

20371.1k7](/packages/hyperf-swagger)[dwolla/dwollaswagger

16462.0k](/packages/dwolla-dwollaswagger)[clever/clever-php

231.6k](/packages/clever-clever-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)