后端接口文档

关于后端接口文档

一般包含以下内容：

1. 该接口的路径
2. 该接口提交的数据类型，如：

GET： 获取数据
POST： 提交或者创建
PATCH： 修改数据，部分修改
DELETE ：删除数据
PUT： 修改数据，整体替换原有数据

3. 参数类型/格式，比如是json格式，还是application/x-www-form-urlencoded的数据

4. 参数字段及限制条件
   参数字段：就是该参数想提交给服务端需要哪些数据（字段），比如用户验证接口，就需要提交用户的id，密码；创建博客的接口，需要提交博客的标题，介绍与内容。
   限制条件：比如提交的用户名必须是多长，不能使用哪些字符

5. 返回成功的数据格式

6. 返回失败的数据格式

7. 后端接口线上地址的根路径
   可以是开发环境的的线上路径，也可以是项目真正发布后的线上路径