接口开发，最麻烦的就是写文档了，曾经我也因为写接口文档苦不堪言；自从使用了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":[
            
            {
                &quo