zhaojunlike/think-swagger

适用于ThinkPHP5的swagger

维护者

详细信息

github.com/zhaojunlike/think-swagger

主页

源代码

问题

安装: 15

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 2

开放问题: 0

2.0.2 2018-11-18 04:44 UTC

Requires

MIT 14c3c1c70bf539eb447c980632922dd22f0ac9b6

  • westhack <452855489.woop@qq.com>
  • zhaojunlike <1716771371.woop@qq.com>

This package is auto-updated.

Last update: 2024-09-18 21:14:55 UTC

README

ThinkPHP5的swagger Swagger composer模块

ThinkPHP 5.0版本可以使用：https://github.com/westhack/think-swagger

此版本兼容了5.1之后的版本

安装

一、执行命令安装

composer require zhaojunlike/think-swagger

使用

添加配置文件

  1. 默认配置在config目录下的swagger.php文件中
  2. 需要自定义配置，将config目录下的swagger.php文件复制到extra目录下（或者通过以下控制台添加配置文件）

使用方法

初始化项目资源

在项目目录下找到command.php文件，添加控制台命令添加以下配置

    return [
        'westhack\swagger\SwaggerAssetRegister'
    ];

执行console命令初始化assets资源

    php think swaggerAssetRegister   ## 默认资源目录
    php think swaggerAssetRegister --path /public/static   ## 绝对路径
    php think swaggerAssetRegister --path swagger/ui   ## 默认资源目录下面的路径

执行console命令初始化config配置

    php think swaggerAssetRegister --config y   ## 初始化 config 配置

访问

    http://你的域名/index.php?s=swagger/ui ## swagger ui
    http://你的域名/index.php?s=swagger/api ##  swagger json
    http://你的域名/index.php?s=swagger/api&clear-cache ## 清除缓存（如果开启缓存）

在php文件中添加注释

/**
 * @SWG\Info(title="My First API", version="0.1")
 */

/**
 * @SWG\Get(
 *     path="/api/resource.json",
 *     @SWG\Response(response="200", description="An example resource")
 * )
 */

如图