接口文档swagger

在实际项目中,作为后端人员一般都需要提供给前端或者测试人员一些文档类说明,这个过程有时候比写代码还要痛苦,在这个过程中找到了swagger工具可以很方便的解决这些问题,特此记录一下使用方法:

主要针对laravel框架使用,使用的是github上darkaonline/l5-swagger集成

集成完之后,会有对应配置,相应配置可以去看相关文档,这里主要记录swagger的写法

1.全局配置编写如下(全局配置全项目只写一次,找准确定的控制器写入,方便日后查找):

namespace Controller;

/**

* @SWG\Swagger(

*    basePath="/",

*    @SWG\Info(

*        version="2.0.0",

*        title="收银台_签约商户版本",

*        description="开发环境地址：http://192.168.10.65:9010

测试环境地址：http://test.weixin.78dk.com

生产环境地址：http://weixin.78dk.com",

*        @SWG\Contact(

*            email="zhaosuji@78dk.com"

*        ),

*    ),

* )

*/

class BankinfoController extends Controller{

}

2.局部的配置编写如下

class BankinfoController extends Controller

{    /**

* 获取银行卡信息

*

    * @SWG\Post(path="/v5/bankinfos",

*  tags={"v5版本"},

*  summary="获取银行卡信息",

*  description="收银台_根据银行卡号获取信息",

*  operationId="bankinfos",

*  produces={"application/json"},

    *  @SWG\Parameter(

*    in="formData",

*    name="openid",

*    type="string",

*    description="微信第三方唯一标识",

*    required=true,

*  ),

    *  @SWG\Parameter(

*    in="formData",

*    name="bank_card_no",

*    type="string",

*    description="银行卡号",

*    required=true,

*  ),

    *  @SWG\Response(response="default", description="成功")

* )

*/

    public function create()

{}

}