1 Star 0 Fork 0

HPlus / swagger

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README

hyperf swagger

实现来源于 https://github.com/daodao97/apidog 本插件为了兼容hyperf-plus 做处理

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

1、安装

composer require hyperf-plus/swagger

2、发布配置文件

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

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

完成访问

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

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

配置描述

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

return [
    'output_file' => BASE_PATH . '/runtime/swagger.json',
    'swagger' => '2.0',
    'enable' =>true, // 是否启用web访问
        // 忽略的hook, 非必须 用于忽略符合条件的接口, 将不会输出到上定义的文件中
     'ignore' => function($controller, $action) {
         return false;
     },
     // 自定义验证器错误码、错误描述字段
     'error_code' => 400,
     'http_status_code' => 400,
     'field_error_code' => 'code',
     'field_error_message' => 'message',
     // swagger 的基础配置
     'swagger' => [
         'swagger' => '2.0',
         'info' => [
             'description' => 'hyperf swagger api desc',
             'version' => '1.0.0',
             'title' => 'HYPERF API DOC',
         ],
         'host' => 'apidog.com',
         'schemes' => ['http'],
     ]
];

鸣谢

实现来源于 https://github.com/daodao97/apidog

空文件

简介

暂无描述 展开 收起
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/hyperf-plus/swagger.git
git@gitee.com:hyperf-plus/swagger.git
hyperf-plus
swagger
swagger
master

搜索帮助

14c37bed 8189591 565d56ea 8189591