swagger

1.打开tp下的composer.json修改

"require":{
  "PHP": ">=5.4.0",
  "topthink/framework":"^5.0"
},

//在require后增加zircote/swagger-php

"require":{
  "PHP": ">=5.4.0",
  "topthink/framework":"^5.0",    
   "zircote/swagger-php" :"*"
}

2.之后在根目录运行

composer update

3.等待安装完成后或者直接在打开命令窗口之后运行

composer require zircote/swagger-php


4.提示安装完成后执行

composer global require zircote/swagger-php

在vendor中会生成一个zircote组件文件夹,说明插件安装成功了


5.在public根目录新建一个swaggerApi文件夹(用来存储生成的swagger.json)

php /var/www/html/ownproject/vendor/zircote/swagger-php/bin/swagger  /var/www/html/ownproject/application/index/controller -o  /var/www/html/ownproject/public/swaggerApi/swagger.json

第一个路径是你安装成功后组件的路径;第二个路径是你想要生成这个目录下所有swagger方式注释的PHP文件,把所有注释生成api文档,第三个路径是存放生成swagger.json的路径。

6.可以写个控制器,每次访问时重新生成json文件并且打开swagger

<?php
namespace app\index\controller;
use think\Controller;
class Index extends Controller
{
    public function index(){
        $path = '../application'; //你想要哪个文件夹下面的注释生成对应的API文档
        $swagger = \Swagger\scan($path);
        // header('Content-Type: application/json');
        // echo $swagger;
        $swagger_json_path = '../public/swaggerApi/swagger.json';
        $res = file_put_contents($swagger_json_path, $swagger);
        if ($res == true) {
           $this->redirect('http://www.tpswagger.com/swagger-ui/dist/index.html');
        }
    }
 
}
>


7.在public文件夹下安装swagger

git clone https://github.com/swagger-api/swagger-ui.git

下载下来只要dist目录下的文件(可以修改为 swagger-ui)

替换index.html SwaggerUIBundle url//更改此url为你tp5内生成的json文件

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值