HTTP API接口设计规范
Posted 懂电商API接口的Jennifer
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了HTTP API接口设计规范相关的知识,希望对你有一定的参考价值。
1. 所有请求使用POST方法
-
使用post,相对于get的query string,可以支持复杂类型的请求参数。例如日常项目中碰到get请求参数为数组类型的情况。
-
便于对请求和响应统一做签名、加密、日志等处理
2. URL规则
-
URL中只能含有英文,使用英文单词或简称,不要使用汉语拼音
-
所有字符使用小写字母
-
多个单词之前使用连字符
-
分隔,如third-login
, 不要使用thirdlogin
,thirdLogin
或third_login
-
URL的path部分使用
系统/模块/操作
的格式,如ims/video/list
- 系统,表示这个接口是微服务中的哪个服务,可使用简称
- 模块,表示系统的子模块。模块名字使用名词全称,且使用单数形式
- 操作,表示具体的接口,使用动词+名词的形式,需要考虑单复数。比如
add-user
,list-users
,delete-users
3. HTTP头部
- 将具体业务无关的数据放在HTTP headers
- 后端系统可以在不涉及请求和响应体的情况下,处理一些公用逻辑
4. 请求和响应体
- 使用
utf-8
编码 - JSON格式
- 如果需要加密,可以将正常的JSON加密后用base64编码
5. HTTP状态码
- 业务的处理结果不体现在http状态码,由响应体的错误码字段表示
- 只是有部分http状态码表示业务无关的响应,例如
200
: 业务已处理,但是处理成功还是失败由响应体表示400
: 错误的请求,多用在请求参数验证。客户端开发要保证向服务器提交正确格式的请求401
: 认证失败,一般没有token或者没有token过期403
: 没有权限调用这个接口。客户端应该隐藏用户无权限的操作500
: 服务器异常
6. 字段命名
- JSON来自javascript语言,所以字段命名遵循javascript语言,使用
lowerCamelCase
小骆驼拼写法 - 不要使用下划线链接的
snake_case
7. 数据类型
常用数据类型映射
- bool:映射为 string,使用Y表示true,N表示false
- int: 映射为number
- long: 映射为string,因为js的number类型能处理的数值范围不够,实际项目中会导致各种奇怪的问题
- float, double, decimal: 映射为string
- 日期、时间:映射为string
注意:
- 表示ID概念的字段,统一使用string
- 数据传输时,如果某个字段为空值,直接省略这个字段不传,减少网络开销
- 响应体业务数据包含多个数据结构时,优先使用嵌套格式,例如下面这个用户创建的消息
"item":
"num_iid": "520813250866",
"title": "三刃木折叠刀过安检创意迷你钥匙扣钥匙刀军刀随身多功能小刀包邮",
"desc_short": "",
"price": 25.8,
"total_price": 0,
"suggestive_price": 0,
"orginal_price": "25.80",
"nick": "欢乐购客栈",
"num": "832",
"min_num": 0,
"detail_url": "http://item.taobao.com/item.htm?id=520813250866",
"pic_url": "//img.alicdn.com/imgextra/i4/2596264565/TB2p30elFXXXXXQXpXXXXXXXXXX_!!2596264565.jpg",
"brand": "三刃木",
"brandId": "4036703",
"rootCatId": "50013886",
"cid": "50014822",
"favcount": "4824",
"fanscount": "1469",
"crumbs": [],
"created_time": "",
"modified_time": "",
"delist_time": "",
8. 响应体格式
code
业务处理的错误码,使用简短的能够体现错误种类的英文单词表示,使用大写字母,使用下划线分隔单词。不建议用数字表示错误码,用数字表示需要额外维护错误码表。
restful 接口设计规范
restful 接口设计规范
1. 域名
应该尽量将API部署在专用域名之下。
https://api.example.com
如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。
https://www.example.org/api/
2. 版本(Versioning)
应该将API的版本号放入URL。
http://www.example.com/app/1.0/foo
http://www.example.com/app/1.1/foo
http://www.example.com/app/2.0/foo
另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。Github就采用了这种做法。
因为不同的版本,可以理解成同一种资源的不同表现形式,所以应该采用同一个URL。版本号可以在HTTP请求头信息的Accept字段中进行区分(参见Versioning REST Services):
Accept: vnd.example-com.foo+json; version=1.0
Accept: vnd.example-com.foo+json; version=1.1
Accept: vnd.example-com.foo+json; version=2.0
3. 路径(Endpoint)
路径又称"终点"(endpoint),表示API的具体网址,每个网址代表一种资源(resource)
(1) 资源作为网址,只能有名词,不能有动词,而且所用的名词往往与数据库的表名对应。
举例来说,以下是不好的例子:
/getProducts
/listOrders
/retreiveClientByOrder?orderId=1
对于一个简洁结构,你应该始终用名词。 此外,利用的HTTP方法可以分离网址中的资源名称的操作。
GET /products :将返回所有产品清单
POST /products :将产品新建到集合
GET /products/4 :将获取产品 4
PATCH(或)PUT /products/4 :将更新产品 4
(2) API中的名词应该使用复数。无论子资源或者所有资源。
举例来说,获取产品的API可以这样定义
获取单个产品:http://127.0.0.1:8080/AppName/rest/products/1
获取所有产品: http://127.0.0.1:8080/AppName/rest/products
3. HTTP动词
对于资源的具体操作类型,由HTTP动词表示。
常用的HTTP动词有下面四个(括号里是对应的SQL命令)。
- GET(SELECT):从服务器取出资源(一项或多项)。
- POST(CREATE):在服务器新建一个资源。
- PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
- DELETE(DELETE):从服务器删除资源。
CURD Create、Update、Read、Delete 增删查改,这四个数据库的常用操作
还有三个不常用的HTTP动词。
- PATCH(UPDATE):在服务器更新(更新)资源(客户端提供改变的属性)。
- HEAD:获取资源的元数据。
- OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的。
下面是一些例子。
GET /zoos:列出所有动物园
POST /zoos:新建一个动物园(上传文件)
GET /zoos/ID:获取某个指定动物园的信息
PUT /zoos/ID:更新某个指定动物园的信息(提供该动物园的全部信息)
PATCH /zoos/ID:更新某个指定动物园的信息(提供该动物园的部分信息)
DELETE /zoos/ID:删除某个动物园
GET /zoos/ID/animals:列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物
4. 过滤信息(Filtering)
如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。
下面是一些常见的参数。query_string 查询字符串,地址栏后面问号后面的数据,格式: name=xx&sss=xxx
完整的URL地址格式:
协议://域名(IP):端口号/路径?查询字符串#锚点
?limit=10:指定返回记录的数量
?offset=10:指定返回记录的开始位置。
?page=2&per_page=100:指定第几页,以及每页的记录数。
?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。
?animal_type_id=1:指定筛选条件
参数的设计允许存在冗余,即允许API路径和URL参数偶尔有重复。比如,GET /zoos/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。
6. 状态码(Status Codes)
1xx 表示当前本次请求还是持续,没结束
2xx 表示当前本次请求成功
3xx 表示当前本次请求成功,但是服务器进行代理操作/重定向
4xx 表示当前本次请求失败,主要是客户端发生了错误
5xx 表示当前本次请求失败,主要是服务器发生了错误
服务器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)。
- 200 OK - [GET]:服务器成功返回用户请求的数据
- 201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
- 202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
- 204 NO CONTENT - [DELETE]:用户删除数据成功。
- 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作
- 401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
- 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
- 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
- 406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
- 410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
- 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
- 500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
- 507 数据存储出错,往往数据库操作错误出错,服务器就返回这个
7. 错误处理(Error handling)
如果状态码是4xx,服务器就应该向用户返回出错信息。一般来说,返回的信息中将error作为键名,出错信息作为键值即可。
{
error: "Invalid API key"
}
8. 返回结果
针对不同操作,服务器向用户返回的结果应该符合以下规范。
- GET /collection:返回资源对象的列表(数组)
- GET /collection/ID:返回单个资源对象(json)
- POST /collection:返回新生成的资源对象(json)
- PUT /collection/ID:返回完整的资源对象(json)
- DELETE /collection/ID:返回一个空文档(空字符串)
9. 超媒体(Hypermedia API)
RESTful API最好做到Hypermedia(即返回结果中提供链接,连向其他API方法),使得用户不查文档,也知道下一步应该做什么。
比如,Github的API就是这种设计,访问api.github.com会得到一个所有可用API的网址列表。
{
"current_user_url": "https://api.github.com/user",
"authorizations_url": "https://api.github.com/authorizations",
// ...
}
从上面可以看到,如果想获取当前用户的信息,应该去访问api.github.com/user,然后就得到了下面结果。
{
"message": "Requires authentication",
"documentation_url": "https://developer.github.com/v3"
}
上面代码表示,服务器给出了提示信息,以及文档的网址。
10. 其他
服务器返回的数据格式,应该尽量使用JSON,避免使用XML。
XML是W3C为了替换HTML研发出来的,但是现在很明显失败了。
,xml 配置文件
<xml version="1.0" charset="utf-8">
<name>张三</name>
<sex>男</sex>
<age>18</age>
</xml>
{
“name”:"张三",
"sex":"男",
"age":18
}
以上是关于HTTP API接口设计规范的主要内容,如果未能解决你的问题,请参考以下文章