接口命名

请求方式

内容格式

常用的请求格式一般为www-form-urlencoded，application/json，multipart/form-data。

接口传参设计

  1. 需要校验接口的传入参数，保证其合法性。
  2. 不要设计大而全的请求类来接收参数，这样的请求类不容易进行控制。调用者也不明确自己需要传的参数有哪些。
  3. 对于用户id这类参数，能不让前端传的就不要前端传。这时如果没校验userId，会引起数据安全问题（数据泄露，数据篡改等）。

响应参数设计

  1. 响应体的每个参数都需要明确，如code代表错误码，message代码错误消息，data代表数据。
  2. 对于一些比较明确的错误，可以使用http status来返回错误信息。如400(Bad Request)，401(Unauthorized)，403(Forbidden)， 404(Not Found)。
  3. 对于调用一些三方接口得到的响应信息，应该也转换成业务方自己的响应参数。