接口开发,最麻烦的就是写文档了,曾经我也因为写接口文档苦不堪言;自从使用了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文件;

请求一下接口:

希望对您有帮助,谢谢!

接口文档神器--apiui的使用的更多相关文章

  1. Eolinker API 接口文档神器

    Eolinker API 接口文档神器 群里小伙伴推荐的,还没有去研究,先记下来. API文档管理.自动化测试.开发协作利器 正在为数万企业管理超过100万APIs,提高开发效率以及规范开发流程

  2. 接口文档神器Swagger(下篇)

    本文来自网易云社区 作者:李哲 二.Swagger-springmvc原理解析 上面介绍了如何将springmvc和springboot与swagger结合,通过简单配置生成接口文档,以及介绍了swa ...

  3. 接口文档神器Swagger(上篇)

    本文来自网易云社区 作者:李哲 接口文档管理一直是一个让人头疼的问题,伴随着各种接口文档管理平台涌现,如阿里开源的rap,ShowDoc,sosoapi,等等(网上能找到很多这种管理平台,包括我们自己 ...

  4. JApiDocs(自动生成接口文档神器)

    JApiDocs教程 前言 作为一名优秀的程序员来说,由于涉及到要与前端进行对接,所以避免不了的就是写接口文档.写完接口文档,一旦代码返回结果,参数等出现变动,接口文档还得随之改动,十分麻烦,违背了我 ...

  5. Api接口文档管理工具,你知道哪些呢?

    上周看到有人在我的Github开源项目中提了个issue,说是否考虑接入swagger.那今天我就用swagger与其他接口文档工具做对比,同时说说Api接口文档工具的那点事.如今,在前后端分离开发的 ...

  6. springboot+swagger接口文档企业实践(上)

    目录 1.引言 2.swagger简介 2.1 swagger 介绍 2.2 springfox.swagger与springboot 3. 使用springboot+swagger构建接口文档 3. ...

  7. 【开源】.Net Api开放接口文档网站

    开源地址:http://git.oschina.net/chejiangyi/ApiView 开源QQ群: .net 开源基础服务  238543768 ApiView .net api的接口文档查看 ...

  8. 用Swagger生成接口文档

    Swagger简介 在系统设计的时候,各个应用之间往往是通过接口进行交互的.因此接口的定义在整个团队中就变得尤为重要.我们可以把接口的规范用接口描述语言进行描述,然后Swagger可以根据我们定义的接 ...

  9. Swagger+Spring mvc生成Restful接口文档

    简介 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集 ...

随机推荐

  1. Hello, GitHub!

    GitHub作为版本控制的软件,我决定重新系统学习这个东西,毕竟以前都是fork.clone... 1. 理解Git思维 首先呢,我一开始就被GitHub和Git两个东西搞昏了,所以有必要理解二者的关 ...

  2. Mark一下在模仿团购App搭建页面时犯的低级错误

    1.关于Xib拖线错误 2.下面这个错误的根源其实是代码提示时直接敲下了回车,没看仔细,导致后来找了好久才发现该错误,郁闷啊!

  3. jQuery获取所有父级元素及同级元素及子元素的方法

    jQuery获取所有父级元素及同级元素及子元素的方法 1.获取父级元素 $("#id").parent() 获取其父级元素 $("#id").parents() ...

  4. Oracle 11g密码过期问题

    Oracle 11g默认用户密码会在使用180天后过期,我们可以通过dba_users数据字典看一下用户的信息. SQL> select username,account_status,lock ...

  5. 获取屏幕翻转:var resizeEvt = 'orientationchange' in window ? 'orientationchange' : 'resize'

    var resizeEvt = 'orientationchange' in window ? 'orientationchange' : 'resize',这段是为了获取移动端屏幕是否翻转(手机重力 ...

  6. 可能是catalan数吧

    What's the number of distinct BSTs containing nodes {1, 2, 3 ,4}? 包含节点{1,2,3,4}的不同二叉搜索树有多少棵? int Num ...

  7. [译文][转载]greenlet:轻量级并发程序

    英文原文地址:https://greenlet.readthedocs.io/en/latest/中文翻译转载地址:https://zhuanlan.zhihu.com/p/25188731 背景 g ...

  8. mysql集群压测

    mysql压测 mysql自带就有一个叫mysqlslap的压力测试工具,通过模拟多个并发客户端访问MySQL来执行压力测试,并且能很好的对比多个存储引擎在相同环境下的并发压力性能差别.通过mysql ...

  9. 基于Bootstrap Ace模板+bootstrap.addtabs.js的菜单

    这几天研究了基于bootstrap Ace模板+bootstra.addtabs.js实现菜单的效果 参考了这个人的博客 https://www.cnblogs.com/landeanfen/p/76 ...

  10. 使用Screen管理远程会话

    ​ 在本地开发时,经常需要使用远程连接到Linux服务器,一开始我自己都是有几个远程就开几个SSH窗口,这种方法很原始很直接,但每次都受够了密码输入,即使用了SSH免密码登录,也会觉得每次输入SSH的 ...