包简介

A swagger library for Hyperf.

README 文档

README

介绍

基于 tw2066/dto tw2066/api-docs 框架改进而来，特别鸣谢tw2066/dto给的灵感

运行环境

php >= 8.2
hyperf >= 3.0

安装

composer require baoziyoo/hyperf-api-doc
php bin/hyperf.php vendor:publish baoziyoo/hyperf-api-doc

使用

例子

use Baoziyoo\Hyperf\ApiDocs\Annotation\Api;
use Baoziyoo\Hyperf\ApiDocs\Annotation\ApiHeader;
use Baoziyoo\Hyperf\ApiDocs\Annotation\ApiOperation;

#[Api(tags: 'demo管理')]
#[ApiHeader('token')]
#[ApiHeader('tokenType')]
class DemoController extends AbstractController
{
    #[ApiOperation('登陆')]
    public function index(#[RequestQuery] DemoQuery $request): Contact
    {
        $contact = new Contact();
        $contact->name = $request->name;
        var_dump($request);
        return $contact;
    }

    #[ApiOperation('更新token')]
    public function add(#[RequestBody] DemoBodyRequest $request, #[RequestQuery] DemoQuery $query)
    {
        var_dump($query);
        return json_encode($request, JSON_UNESCAPED_UNICODE);
    }

    public function fromData(#[RequestFormData] DemoFormData $formData): bool
    {
        $file = $this->request->file('photo');
        var_dump($file);
        var_dump($formData);
        return true;
    }
}

baoziyoo/hyperf-api-doc 适用场景与选型建议

baoziyoo/hyperf-api-doc 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 3.02k 次下载、GitHub Stars 达 0，最近一次更新时间为 2023 年 03 月 09 日，在 PHP 生态内属于活跃度较高的组件。

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

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

围绕 baoziyoo/hyperf-api-doc 我们能提供哪些服务？

定制开发 / 二次开发

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

BUG 修复 & 性能优化

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

项目外包 & 长期维护

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

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