restful接口文档

1、先理清业务bai流程

2、定义前后端开发的接口规范。比如json的格dao式，url的格式

3、定内义接口文容档，这里的接口文档一般就是对应后台的实体reqVo（调用后台接口<控制器>访问的实体）和返回给前台的respVo（前台调用接口的返回的实体）。注意一般respVo都会有在后台做一个统一的处理为ResultVo（这个规范在2中要定义好，比如：错误码，错误描述，请求的url，请求时间，以及实体T<这个实体才是真正的respVo和业务相关,这个一般都是实体>）

4、定义接口文档是在了解业务流、数据流基础之上完成的。有了这个接口文档（其实就是定义实体的过程和对应的json）前后端的开发基本按照这个文档去开发。接口文档会有版本迭代，一般放到svn上，供所有开发人员阅览

5、现在一般系统用到的数据库都不会是单纯mysql了。还有redis，mongo、es等。这些个人感觉都是在十分了解业务的情况和系统架构下去设计的。后台运用这些工具去完成接口功能的实现已经系统功能和性能的实现。这个和接口文档先后顺序还真不好说，个人觉得都可以。

6、业务流-数据流-资金流。去了解和设计系统。

1、系统架构的思想。业务流-数据流-资金流
2、代码编写再最后，数据库的设计和接口文档的顺序看情况。业务很清楚了，可以同时进行。业务不清楚和没有定义接口校验的人可以先建库再来定义接口文档。
3、定义好借口文档的目的是让团队中的前后端人员尽快进入开发流程，无论如何功能代码都应该放到最后，架构代码一般架构或者技术lead在技术讨论和系统基盘的时候会写一下（这个过程应该会在接口文档同时）
4、下面提问的1、0不要去理会。那都是实现细节。按照接口文档实现功能即可。在开发工程中，技术lead会对你的点质量进行校验（也就是代码质量和功能）
5、没有具体的流程。要根据团队的人数、角色和工作情况来定。

1、功能代码放到最后编写
2、接口文档其实就是根据理解一个功能点后的根据后台实体编写。这个可以给模板后由初级或者是实习编写（现在也可有用swagger2来直接根据controller来完成）
3、接口文档写好后，前后端都要根据这个来实现数据的请求和后台数据的返回。这个就是前后端交流的桥梁。后面联合测试也会根据接口文档来完成。当然在开发过程中有修改及时更新接口文档并广而告之
4、网页链接这是支付宝的接口文档你可以按照它的格式来。不外乎：介绍、请求地址和请求方式、入参、出参、错误码等等。

https://zhuanlan.zhihu.com/p/86735839

https://wenku.baidu.com/view/e1f374cb77c66137ee06eff9aef8941ea76e4b95.html#