HTTP接口规范

一、目的

本规范旨在为公司规范前后端之间、及各业务系统之间HTTP API接口调用与交互。

二、规范

1 HTTP报文头规范

1.1 HTTP Method使用规范

• 每一个HTTP接口，实现时必须明确指定允许的HTTP Method，不允许默认
• HTTP Method用途分类的规定

HTTP Method	用途描述	备注
GET	查询业务数据列表，查询业务数据详情	比如：查询用户信息
POST	新增业务数据	比如：用户注册，用户登录
PUT	修改业务数据(修改完整数据)	客户端上传完整数据，也可以用 POST
PATCH	修改业务数据(修改部分数据字段)	客户端上传部分字段数据，可以理解为对数据打个小补丁，也可以用 POST
DELETE	删除业务数据	非RESTful风格可以允许使用POST