thinkphp5集成Swagger-PHP

浏览:4788 发布日期:2019/07/17 分类:功能实现 关键字: Thinkphp5 Swagger-PHP Swagger-UI
学习 Swagger 过程中发现网上大部份的资料都不是特别全,所以特别发文把自己的排坑历程写出来,希望能对大家有帮助。
1、安装swagger-php2.0
(注:我下载的是swagger-php2.0,本文针对swagger-php2.0)
composer require zircote/swagger-php: 2.0.*

2、下载swagger-ui
去swagger-ui官网下载静态页面,把静态页面放到thinkphp框架目录里,例如public目录。
https://swagger.io/tools/swagger-ui/官方链接
3、thinphp框架引入swagger-php,生成swagger.json文件use Swagger\Annotations as SWG;
class Index
{
    public function index()
    {
        $swagger=\Swagger\scan(__DIR__);
        $res=$swagger->saveAs('./swagger.json');
    }
}
4、文档注释部分 /**
     * @SWG\Swagger(
     *     schemes={"http"},
     *     host="www.tp.com.cn/",
     *     basePath="/",
     * @SWG\Info(
     *     title="API文档",
     *     version="1.0.0",
     * )
     * ),
详细关于Swgger-php的使用说明请访问
https://www.kancloud.cn/chengguang/swagger-php#/catalog
评论( 相关
后面还有条评论,点击查看>>