Thinkphp下搭建Swagger UI

作为后台开发人员,总是避免不了要给APP写API接口文档,之前都是用HTML5和CSS3+Jqury去写动态页面,但是每次修改的时候很麻烦,而且有可能改完代码忘记修改文档,所以就在网上找了些资料,发现Swagger ui这个框架大家都是比较推荐的,现在就记录一下环境的搭建。
Swagger ui 也是基于html+javascript实现的,而且可以实现在线测试的功能,方便开发人员和测试人员进行测试和查看接口调用的结果信息。
Ubuntu14.04和Thinkphp框架下安装Swagger UI:

     1. $ cd /var/www/Api
     2. 安装Composer
         $ apt-get update
         $ curl -sS https://getcomposer.org/installer | php
         $ /usr/bin/php composer.phar --version
         $ sudo mv composer.phar /usr/local/bin/composer
         $ composer -version
         出现以下信息,证明安装成功

这里写图片描述

3. 安装swagger-php
    $ composer require zircote/swagger-php
    $ composer global require zircote/swagger-php
  1. 这时在Api文件夹下会生成一个vendor的文件夹,说名安装成功
  2. 下载 Swagger UI文件: https://github.com/swagger-api/swagger-ui
  3. 下载成功之后可以放到自定义目录,注该目录可以访问到
  4. 修改 dist目录下的index.html页面

    这里写图片描述

    修改生成的json文件路径,不要着急下面就说明怎么生成json文件

    1. 我是在Api文件夹下,新建的swagger-docs文件夹,然后运行命令
    $ php /var/www/Api/vendor/zircote/swagger-php/bin/swagger /var/www/Api/vendor/zircote/swagger-php/Examples -o /var/www/Api/swagger-docs/swagger.json
  1. 访问 dist文件下面的index.html就OK了

    这里写图片描述

    关于json文件的内容怎么生成,可以参考Examples文件夹下面的文件。

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值