包简介

A swagger library for Hyperf.

README 文档

README

hyperf-swagger 注解自动生成文档，配合mzh/validate 验证器可自动根据验证规则、场景生成文档所需参数，无需手动编写doc文档

1、安装

composer require mzh/hyperf-swagger

2、发布配置文件

php bin/hyperf.php vendor:publish mzh/hyperf-swagger

默开启文档web访问，如需关闭，在 config/autoload/swagger.php 将enable设为false

3、配置dependencies

// config/dependencies.php  重写 DispathcerFactory 依赖
<?php
declare(strict_types=1);

return [
    'dependencies' => [
        Hyperf\HttpServer\Router\DispatcherFactory::class => Mzh\Swagger\DispathcerFactory::class
    ],
];

完成访问

通过以上配置后，启动项目访问

http://您的域名/swagger/index 即可直接展示

配置描述

// config/autoload/swagger.php  swagger 基础信息
<?php
declare(strict_types=1);

return [
    'output_file' => BASE_PATH . '/public/swagger.json',
    'swagger' => '2.0',
    'enable' =>true, // 是否启用web访问
    'info' => [
        'description' => 'hyperf swagger api desc',
        'version' => '1.0.0',
        'title' => 'HYPERF API DOC',
    ],
    'host' => 'hyperf.io',
    'schemes' => ['http']
];

鸣谢

思路实现来源于 https://github.com/daodao97/apidog 本插件为改良版本

mzh/hyperf-swagger 适用场景与选型建议

mzh/hyperf-swagger 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 229 次下载、GitHub Stars 达 4，最近一次更新时间为 2020 年 07 月 12 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「php」「swagger」「swoole」「hyperf」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 mzh/hyperf-swagger 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 mzh/hyperf-swagger 我们能提供哪些服务？

定制开发 / 二次开发

基于 mzh/hyperf-swagger 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发