java随手笔记：编写接口文档规范

#作为一个新手会遇见各种问题，通过查看其他人资料和实践，做一份笔记.

一、什么是接口？

	1.在前后端分离时，前端负责写页面，通过查看接口文档从后端拿到数据（传参、返回值）。文档一般都是由后 端开发人员负责编写，
	每一个接口对应的一个功能的实现（例如：查看列表、查看详情信息、添加用户、删除等功能）
	2.还有一种接口就是拱第三方调用，（比如：在借贷中的查看信用程度，就是第三方接口）

二、写接口的步骤

*这仅是限于我自己的开发习惯（前后分离）
1. 先确定自己需要实现什么功能，是需要查看（查看列表是否需要分页）还是编辑、添加等功能
2. 确定自己是否需要传参数，要是传参是要哪些参数（必要字段），返回结果是什么（对象、集合等）
3. 我一般都是从Controller层开始写。再写service层的Interface，再写service层的实现层（impl层）
最后写mapper层的SQL语句
4.controller层：

5.service层：
interface比较简单：返回值 方法名（参数类型 参数1，参数类型 参数2）；
impl层主要就是业务逻辑，相对而言复杂一点：重写了interface层的方法，调用mapper层的方法（sql语句）

6.mapper（主要是写sql）
7.写完方法要写好相应接口的文档（格式如下）

注：有借鉴其他大神的文章，望见谅！