Restful API 学习笔记

  REST全称是Representational State Transfer,表述状态转移??什么东西?简单来说,REST指的是一组架构约束条件和原则。如果一个架构符合REST的约束条件和原则,我们就称它为RESTful架构。

  • Resource:资源,即数据。
  • Representational:某种表现形式,比如用JSON,XML,JPEG等;
  • State Transfer:状态变化。通过HTTP动词实现。

1.URI

URI表示资源,资源一般对应服务器端领域模型中的实体类。

  • 不用大写;
  • 用中杠-不用下杠_;
  • 参数列表要encode;
  • URI中的名词表示资源集合,使用复数形式。

版本号
有些API在URI里边带上版本号,例如:
http://api.example.com/1.0/foo
http://api.example.com/1.2/foo
http://api.example.com/2.0/foo

2.restful CRUD

  http请求方式

  • GET(SELECT):从服务器取出资源(一项或多项)。
  • POST(CREATE):在服务器新建一个资源。
  • PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
  • PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。
  • DELETE(DELETE):从服务器删除资源。

转自https://blog.csdn.net/trecn001/article/details/88573427

后端需要通过@Pathvariable指定参数,和@RequestMethod指定请求类型,来区分不同的前端请求。

3.过滤信息

  • ?limit=10:指定返回记录的数量
  • ?offset=10:指定返回记录的开始位置。
  • ?page=2&per_page=100:指定第几页,以及每页的记录数。
  • ?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。
  • ?animal_type_id=1:指定筛选条件

4.状态码

200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。
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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

http://www.ruanyifeng.com/blog/2014/05/restful_api.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 用了两年的RESTful接口,能意会RESTful是什么,但是很难给别人讲清楚。前两天在知乎上看到了“怎样用通俗的...
    风千寻艾阅读 9,092评论 0 1
  • 一说到REST,我想大家的第一反应就是“啊,就是那种前后台通信方式。”但是在要求详细讲述它所提出的各个约束,以及如...
    时待吾阅读 8,767评论 0 19
  • 1. 什么是Restful Restful是互联网软件的架构原则。什么是互联网软件的架构原则呢?互联网软件的架构原...
    梦醉书香阅读 3,982评论 0 1
  • 一、什么是API? API(Application Programming Interface,应用程序编程接口)...
    Fairy_妍阅读 63,143评论 2 42
  • 小胡是个独立、自爱、有想法的女生。 她似乎从来不缺少男人的追求,即使已经结婚生子。而每一个追求过她的男人都会甘愿为...
    梨雪阅读 3,025评论 0 0