碧海长天

好看的皮囊千篇一律,有趣的灵魂万里挑一。

php下swagger的安装与使用

2018-5-16

一、Swagger介绍

官网:https://swagger.io/ 
说明:Swagger的使用目的是方便优美的呈现出接口API的各种定义, 生成API文档, 包括参数, 路径之类. 有时后端改了API的参数或者其他设置, 前端直接看这个Swagger UI就可以, 方便项目管理和团队协作。
使用流程:
swagger.png

效果图:


二、安装
        1.前端安装
        
        git clone https://github.com/swagger-api/swagger-ui.git
      下载之后找到dist目录, 打开index.html把其中的那一串url改成自己的, 比如 http://matrixdocs.slidyy.com/swagger-php/docs/beike.json
        
    $(function () {
      var url = window.location.search.match(/url=([^&]+)/);
      if (url && url.length > 1) {
        url = decodeURIComponent(url[1]);
      } else {
        url = "http://matrixdocs.slidyy.com/swagger-php/docs/beike.json";
      }
        还可以把界面调整成中文, 放开js文件的注释即可
     <script src='lang/translator.js' type='text/javascript'></script>
     <!-- <script src='lang/ru.js' type='text/javascript'></script> -->
     <script src='lang/zh-cn.js' type='text/javascript'></script>
          然后访问改html文件就能看到页面了, 应该是没内容的, 因为还没生成swagger.json, 生成好之后你设置的URL就起了作用, 直接访问前端就好    

2.安装后端

    git clone https://github.com/zircote/swagger-php.git
   
    利用swagger 后端生成json
   
   php /data0/www/htdocs/swagger-php/bin/swagger /data0/www/htdocs/swagger-php/Matrix/contract  -o /data0/www/htdocs/matrix-web-test/docs/matrixcontract-yuan.json

    这句话的意思是 php 执行 swagger 将Matrix/contract 目录下的代码注释 生成json到指定位置 /data0/www/htdocs/swagger-php/docs/test.json

    这样在前端安装时配置的 http://matrixdocs.slidyy.com/swagger-php/docs/test.json 就有了新的内容

    再访问前端html就能看到swagger内容了~

标签: 后端开发 PHP

发表评论: