CodeIgniter+swagger实现 PHP API接口文档自动生成功能 自动生成ci RESTFUL api接口文档

一、安装swagger

1、首先需要有composer，没有的自行百度安装

2、下载swagger，打开网站https://packagist.org/packages/zircote/swagger-php，根据自己的php版本选择对应的版本号

3、安装：PhpStorm打开项目，然后在左下角

点击Terminal弹窗黑窗口然后在里面输入：composter require zircote/swagger-php 2.0.13    回车，开始安装

4、项目目录

5、使用，安装成功后，在CodeIgniter控制器中(D:/wwwroot/CodeIgniter/site/admin/application/controllers/)新建Swagger.php

load->view('swagger','');
    }
}

6、然后创建视图文件（D:/wwwroot/CodeIgniter/site/admin/views/controllers/swagger.php）,这里要下载（swagger-ui-master.zip，解压到相应目录，然后把dist中的index.html文件中的内容复制到swagger.php中，再把json文件路径改成自己的就可以），这样每次修改api接口注释信息的时候就会自动生成json文件

路径： 域名/swagger/swagger-docs/swagger.json

  var url = "https://api.aa.com/asset/swagger/swagger-docs/swagger.json";

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    

    




    

        

            

                Toggle navigation
                
接口文档
            
            

                

                    
接口文档
                
            
        
    



    

        

            

                

                
            
        
    

二、使用swagger

可以参考这篇博客内容写的还是比较全的（https://laravel-china.org/index.php/topics/7430/how-to-write-api-documents-based-on-swagger-php）

我这简单介绍下：

 

1、在接口控制器目录下创建/api/application/controllers/swagger.php，写API 描述信息

2、在其他接口文件GIT提交

3、Post提交

 * @SWG\Post(
     *     path="/product/product_select",
     *     summary="产品选型接口",
     *     description="返回包含产品选型数据。",
     *     consumes={"application/x-www-form-urlencoded"},
     *     tags={"product"},
     *     @SWG\Parameter(
     *          name="id",
     *          in="formData",
     *          required=true,
     *          default="5037",
     *          description="产品栏目id",
     *          type="number"),
     *       @SWG\Parameter(
     *          name="type",
     *          in="formData",
     *          required=true,
     *          default="1",
     *          description="产品类型 0普通 1小众 2特殊 3与普通二级类别不同",
     *          type="number"),
     *       @SWG\Parameter(
     *          name="child",
     *          in="formData",
     *          default="5077",
     *          description="产品下级栏目id",
     *          type="number"),
     *      @SWG\Parameter(
     *          name="searchIds",
     *          in="formData",
     *          required=false,
     *          description="选型数据:10951,10961,10971",
     *          default="",
     *          type="string"
     *      ),
     *     @SWG\Response(response=200,description="OK")
     * )