接口文档神器--apiui的使用

接口开发，最麻烦的就是写文档了，曾经我也因为写接口文档苦不堪言；自从使用了apiui接口文档神器，工作效率和文档清晰得到了不止一个档次的提升。

下面介绍一下这个神器的使用：

把文件下载下来，放在网站根目录；

链接：https://pan.baidu.com/s/1DaT_rUANaSoHVhy8BjtQRw 密码：atgu

更改index.html文件的三个参数；

然后打开api.json文件，添加对应的接口模块；

 {
     "apiVersion":"0.2",
     "swaggerVersion":"1.1",
     "apis":[
     {
         "path":"/fellow.{format}",
         "description":"会员详情"
     },
     {
         "path":"/red_packet.{format}",
         "description":"红包"
     }

     ]
 }

apis下面一组数据对应就是一个模块；

path参数是模块名，description参数是模块别名，一个模块对应api文件夹下的一个json文件；

然后就编辑api下面的json文件，

 {
     "apiVersion":"0.2",
     "swaggerVersion":"1.1",
     "resourcePath":"/",
     "apis":[
     {
         "path":"/fellow_info",
         "operations":[
         {
             "description":"",
             "updateTime":"2018/4/12 22:17",
             "httpMethod":"GET",
             "summary":"会员资料",
             "apiStatus":2,
             "reviser":"完成",
             "responseClass":"void",
             "nickname":"test0",
             "revisionHighlight":true,
             "fieldDesc":{
                 "result@string":"请求返回的状态1成功0失败",
                 "message@string":"提示信息",
                 "data@string":"返回的数据",
                 "nickname@string":"昵称",
                 "sex@string":"性别",
                 "tel@string":"手机号",
                 "label@string":"标签",
                 "remark@string":"备注",
                 "industry@string":"行业",
                 "company@string":"所在公司",
                 "position@string":"职位",
                 "region@string":"地区",
                 "email@string":"邮箱",
                 "qq_account@string":"QQ号",
                 "wx_account@string":"微信号",
                 "identity@string":"身份"

                 },
             "parameters":[

             {
                 "description":"用户id",
                 "paramType":"body",
                 "required":true,
                 "allowMultiple":false,
                 "dataType":"uid"
             }
             ]
         }
         ]
     },
     {
         "path":"/upd_fellow_info",
         "operations":[
         {
             "description":"",
             "updateTime":"2018/4/12 22:17",
             "httpMethod":"GET",
             "summary":"编辑会员资料",
             "apiStatus":2,
             "reviser":"完成",
             "responseClass":"void",
             "nickname":"test1",
             "revisionHighlight":true,
             "fieldDesc":{
                 "result@string":"请求返回的状态1成功0失败",
                 "message@string":"提示信息",
                 "data@string":"返回的数据"

                 },
             "parameters":[

             {
                 "description":"用户id",
                 "paramType":"body",
                 "required":true,
                 "allowMultiple":false,
                 "dataType":"uid",
                 "defaultValue":"81"
             },
              {
                 "description":"代理商id",
                 "paramType":"body",
                 "required":true,
                 "allowMultiple":false,
                 "dataType":"aid",
                 "defaultValue":"164"
             },
              {
                 "description":"姓名",
                 "paramType":"body",
                 "required":false,
                 "allowMultiple":false,
                 "dataType":"nickname",
                 "defaultValue":"邓丽君"
             },
              {
                 "description":"性别（填男，女，未知）",
                 "paramType":"body",
                 "required":false,
                 "allowMultiple":false,
                 "dataType":"sex",
                 "defaultValue":"女"
             },
              {
                 "description":"手机号",
                 "paramType":"body",
                 "required":false,
                 "allowMultiple":false,
                 "dataType":"tel",
                 "defaultValue":"13800138000"
             },
              {
                 "description":"标签,（传标签名，多个标签时候用,分开）",
                 "paramType":"body",
                 "required":false,
                 "allowMultiple":false,
                 "dataType":"label",
                 "defaultValue":"经理,2月生日"
             },
              {
                 "description":"备注",
                 "paramType":"body",
                 "required":false,
                 "allowMultiple":false,
                 "dataType":"remark",
                 "defaultValue":"她是好人我是好人这是备注"
             },
              {
                 "description":"行业（传行业id）",
                 "paramType":"body",
                 "required":false,
                 "allowMultiple":false,
                 "dataType":"industry",
                 "defaultValue":"4"
             },
              {
                 "description":"公司",
                 "paramType":"body",
                 "required":false,
                 "allowMultiple":false,
                 "dataType":"company",
                 "defaultValue":"嘻哈唱片有限公司"
             },
              {
                 "description":"职位",
                 "paramType":"body",
                 "required":false,
                 "allowMultiple":false,
                 "dataType":"position",
                 "defaultValue":"演员"
             },
              {
                 "description":"地区",
                 "paramType":"body",
                 "required":false,
                 "allowMultiple":false,
                 "dataType":"region",
                 "defaultValue":"香港某条街"
             },
              {
                 "description":"邮箱",
                 "paramType":"body",
                 "required":false,
                 "allowMultiple":false,
                 "dataType":"email",
                 "defaultValue":"6969888@qq.com"
             },
              {
                 "description":"QQ号",
                 "paramType":"body",
                 "required":false,
                 "allowMultiple":false,
                 "dataType":"qq_account",
                 "defaultValue":"6969888"
             },
             {
                 "description":"微信号",
                 "paramType":"body",
                 "required":false,
                 "allowMultiple":false,
                 "dataType":"wx_account",
                 "defaultValue":"DLJ_6969888"
             }

             ]
         }
         ]
     }

     ]
 }

参数apis下面一组数据，就对应一个接口，对应的重要参数如下：

path：接口名，

updateTime：更新时间，

httpMethod：请求方式，

summary：接口功能解释，

nickname：接口别名（同一个模块不可以重名），

fieldDesc：接口返回的数据，一行数据表示一个字段，举例:"result@string":"请求返回的状态1成功0失败",表示返回字段result 数据类型是string，字段说明是‘请求返回的状态1成功0失败’；

parameters：请求接口所需要的参数，一组数据表示一个参数，

description：字段说明，
required：字段是否必填，true是必填参数，false是选填参数
dataType：字段名称，
defaultValue：参数的默认值，

大功告成：访问index.html文件；

请求一下接口：

希望对您有帮助，谢谢！