码迷,mamicode.com
首页 > Windows程序 > 详细

RESTful API规范

时间:2019-07-02 14:48:28      阅读:144      评论:0      收藏:0      [点我收藏+]

标签:处理   成功   one   ble   修改   传参   下一步   新建   返回结果   

1、API与用户的通信协议,总是使用HTTPs协议。

2、域名

  • 1)子域名方式

https://api.example.com 尽量将API部署在专用域名(会存在跨域问题)

  • 2)url方式

https://example.org/api/ API很简单

3、版本

请求头 跨域时,引发发送多次请求

4、面向资源编程: 路径,视网络上任何东西都是资源,均使用名词表示(可复数)

5、method(常用)

GET :从服务器取出资源(一项或多项)

POST :在服务器新建一个资源

PUT :在服务器更新资源(客户端提供改变后的完整资源)

PATCH :在服务器更新资源(客户端提供改变的属性)

DELETE :从服务器删除资源

6、过滤,通过在url上传参的形式传递搜索条件(常用)

7、状态码

‘‘‘1. 2XX请求成功‘‘‘
# 200 请求成功,一般用于GET与POST请求
# 201 Created - [POST/PUT/PATCH]:用户新建或修改数据成功。
# 202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
# 204 NO CONTENT - [DELETE]:用户删除数据成功。
‘‘‘2. 3XX重定向‘‘‘
# 301 NO CONTENT - 永久重定向
# 302 NO CONTENT - 临时重定向
‘‘‘3. 4XX客户端错误‘‘‘
# 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] 当创建一个对象时,发生一个验证错误。
‘‘‘4. 5XX服务端错误‘‘‘
# 500 INTERNAL SERVER ERROR - [*]:服务器内部错误,无法完成请求
# 501 Not Implemented     服务器不支持请求的功能,无法完成请求

8、错误处理,状态码是4xx时,应返回错误信息,error当做key

{ error: “Invalid API key” }

9、返回结果,针对不同操作,服务器向用户返回的结果应该符合以下规范

GET /collection:返回资源对象的列表(数组)

GET /collection/resource:返回单个资源对象

POST /collection:返回新生成的资源对象

PUT /collection/resource:返回完整的资源对象

PATCH /collection/resource:返回完整的资源对象

DELETE /collection/resource:返回一个空文档

10、Hypermedia API

RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么

{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

demo

RESTful API规范

标签:处理   成功   one   ble   修改   传参   下一步   新建   返回结果   

原文地址:https://www.cnblogs.com/zxs117/p/11120464.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!