swagger在thinkphp3.2中的应用

在网上找这个swagger应用的时候,全部几乎都是一个样,就是不行,都是说这样那样的,但是用在你身上就是不行,就是不行

首先不管那么多,直接拿来用,后面再慢慢研究吧

swagger有个ui,你下载吧,里面有个dist文件(不想下载email我,我发给你),直接拷贝放到项目根目录下,别想着放到什么什么好看的文件整理,别想,就放在根目录好了。

然后下载swagger-php,有些人就是分不清,ui还要什么php,什么鬼,好吧,多说一句,swagger UI是界面的展示,而swagger-php是生成接口文档的驱动,这么理解没问题吧,或者简单点,ui就是人家写好的html,swagger-php就是你的php语言。

好了不多说了,我的swagger-php放在根目录的一个vender目录下的,注意这句话,不然又的说没有用了(要文件找我)

文件都弄好了吧,在入口文件index.php加上一句话,就是引入swagger-php库文件,在引入ThinkPHP入口文件之前就可以了

//引入swagger-php导入文件
require './vendor/swagger-php/vendor1/autoload.php';

还没好哦,不是有个dist文件么,里面有个index.html,打开它(编辑器),
找到他

url = decodeURIComponent(url[1]);

在她else的分支上改成这个路径地址别说不会,就是项目直接指到dist的swagger.json就可以了,像这样

url = "http://127.0.0.1/xiangmuming/dist/swagger.json";

基本的就好了,然后到时候你访问http://127.0.0.1/xiangmuming/dist/idnex.html 就是swagger UI接口界面
但是如何生成接口呢,其实就是生成swagger.json,最老土的,也不老土,你觉得方便就好,你可以直接在swagger.json中直接写json文件都可以,如果不愿意的话就继续跟着走,如果你想手动写,就可以不用继续往下看了,已经可以了,okay,完美啦

不想写json的继续,但是也好烦的,不过看的会舒服一点或者说好管理一点

一般人写代码都会判断session存不存在啊,不存在就跳到登录界面啊 什么的 ,
所以你直接写到其他不跟session挂钩的地方吧,我是卸载LoginController下的,加如下代码:

public function createApi(){
        //定义根目录
        $path = __DIR__; //你想要哪个文件夹下面的注释生成对应的API文档
        //echo $path;
        $swagger = \Swagger\scan($path);
        header('Content-Type: application/json');
        //echo $swagger;
        $swagger = (string) $swagger;
        $swagger_json_path = "dist/swagger.json";
        $res = file_put_contents($swagger_json_path,$swagger);
        if ($res == true) {
           //$this->redirect('http://'.$_SERVER['HTTP_HOST'].'/dist/index');
        }
    }

然后访问http://127.0.0.1/xiangmuming/Login/createApi
你的不行,我重写了index.php隐藏的,不行自己好好看看,里面代码自己一个个dump出来自己分析

然后提供一个接口怎么编写示例

/**
      * @SWG\Post(path="/Login/getPhoneVerifyCode",
     *   tags={"1、【未登录】登录注册模块"},
     *   summary=" 获取手机验证码",
     *   description="获取验证码成功后返回data.wtime等待时间
     *                  状态码为200=》
     *                              data.wtime:等待时间
     *                  手机接收不到,不需要300状态码",
     *              
     *   operationId="getPhoneVerifyCode",
     *   produces={"application/json"},
     *   @SWG\Parameter(name="uphone",type="string",require=true,in="formData",description="手机号码"),
     * )
     */

好了,自己研究去,文件的什么直接可以找我,但是里面其他的自己研究,搞定收工!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,333评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,812评论 1 298
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 110,016评论 0 246
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,293评论 0 214
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,650评论 3 288
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,788评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,003评论 2 315
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,741评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,462评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,681评论 2 249
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,168评论 1 262
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,528评论 3 258
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,169评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,119评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,902评论 0 198
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,846评论 2 283
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,719评论 2 274

推荐阅读更多精彩内容