随着前后端分离的普及，日常code中前后端人员扯皮是一个非常常见的事情，所以博主在公司的接口与接口文档编写过程中，制定了一系列的接口文档编写规范。使接口查找更加的明确，入参与出参更加的规范化。这样会大大减少前后端人员沟通的时间。

1.代码规范

1.将同一业务的接口写于1个类中，并写明业务名称，实现方式见图2。

2.详细描述接口，且指定好请求类型，切记不要使用requestmapping，实现方式见图2。

这里有的同学问了，根据restful规则，接口路径只应该是名词，你这不专业啊。因为博主所在公司规模较小，而且人员素质比较一般，所以为了避免在开发时出现一些意外，所以此处并没有采用。

3.写好入参与出参的描述，且入参必须为对象类型。出参也为对象类型。严禁基本类型出入参，实现方式见图2。

4.建立不同的vo返回对象，防止返回值污染。

避免一个vo对象所有的接口都使用，返回了一大堆没有用的字段。