分享人：杨舜
1.背景介绍
2.知识剖析
3.常见问题
4.解决方案
5.编码实战
6.扩展思考
7.参考文献
8.更多讨论
什么是接口文档？
在项目开发中，web项目的前后端分离开发，APP开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。
为什么要写接口文档？
1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发
2、项目维护中或者项目人员更迭，方便后期人员查看、维护
接口规范是什么？
首先接口分为四部分：方法、url、请求参数、返回参数
一、方法:新增(post) 修改(put) 删除(delete) 获取(get)
二、url：以/a开头，如果需要登录才能调用的接口(如新增、修改；前台的用户个人信息，资金信息等)后面需要加/u，即：/a/u；中间一般放表名或者能表达这个接口的单词；
三、请求参数和返回参数，都分为5列：字段、说明、类型、备注、是否必填。
字段是类的属性；
说明是中文释义；
类型是属性类型，只有String、Number、Object、Array四种类型；
备注是一些解释，比如表示0表示上架1表示下架，好让前端更好 的理解；
是否必填就是该字段在界面中是否是必填内容
四、返回参数结构有几种情况：
1、如果只返回接口调用成功还是失败（如新增、删除、修改等），则只有一个结构体：code和message两个参数；
2、如果要返回某些参数，则有两个结构体：1).是code/mesage/data，2).是data里写返回的参数；
3、如果要返回列表，那么有三个结构体，1).是code/mesage/data,2).data是object，里面放置page/size/total/list 4个参数，其中list是Arrary类型，3).list里放object，object里是具体的参数
衡量接口（API）设计好和坏的准则是什么？
单词拼写要准确,接口一旦发布就不能改了，要保持兼容性，拼写错误也不能改了，所以要仔细检查拼写，否则会被同行嘲笑很多年。
方法名称是否可以自描述，即看到方法的名字就能知道方法的作用、看到参数名就知道需要传递什么样的数据（比如getUserById(String userId)）
API一定要便于使用者理解，这样才是广泛传播的基础。如果有些API需要用户掌握特定的概念、定义，那么就要保持这个API的一致性，不能轻易的改变API，否则会给使用者带来很大的麻烦。
接口参数验证必不可少，同时异常等返回信息得全面，让调用者明确异常原由；
百度
感谢观看,如有出错,恳请指正
BY : 杨舜