russellchang54 / PM

daily note
1 stars 0 forks source link

API设计规范 #9

Open russellchang54 opened 7 years ago

russellchang54 commented 7 years ago

1,资源的创建、检索、更新、删除 1.1 创建资源 方法:POST 响应:

201 已创建 Location 头包含新建资源的URL 400 数据格式有错 401 请求中缺少认证信息 403 无权访问 405 不支持POST方法

1.2 检索资源

200 成功获取 401 请求中缺少认证信息 403 无权访问 404 资源不存在

1.3 更新资源信息 1.4 删除资源

2,集合资源

属性:offset, limit, size, items offset,默认为0 limit: 返回最大的集合元素数,最小1,最大100,默认25

2.1 分页: eg: /tenant?offset=10&limit=40

2.2 排序: eg: /tenant?orderBy=username desc&age desc

2.3 检索: 基于 过滤器 检索 基于 属性 检索 基于 时间 检索 基于 coustomData检索

eg: accounts?givenName=Joe&middleName=aul&surname=mit&email=joePaul&status=disabled givenName等于Joe 并且 middleName以aul 结尾 并且 surname 包含 mit 并且 status 等于 disabled

以带区间的时间检索 /accounts?createdAt=[2017-01-01,2017-03-30] 包含边界时间 /accounts?createdAt=[2017-01-01,2017-03-30) 不包含上边界

以自定义字段检索 格式 ?customData.{key}={value}

如果customData里存储的是对象: ?customData.{objectName}.{key}=value

数字范围: ?customData.topScore=(0,1000] ?customData.topScore[50,]

2,登录 方法:POST 用户名/密码错误:返回401 https://docs.stormpath.com/rest/product-guide/latest/reference.html#creating-retrieving-updating-and-deleting-resources http://www.cnblogs.com/xingxueliao/p/5911292.html