RESTful接口规范

HTTP动词

资源的具体操作类型,由HTTP动词表示。

常见的五个HTTP动词(括号对应SQL命令)

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

HTTP状态码

客户端每一次请求,服务区都必须给出回应。回应包括HTTP状态码和数据两部分。

HTTP状态码就是一个三位数,分成五个类别。

  • 1XX:相关信息
  • 2XX:操作成功
  • 3XX:重定向
  • 4XX:客户端错误
  • 5XX:服务器错误

常见状态码:(方括号中对应该状态码的HTTP动词)

  • 200 OK - [GET]:服务器成功返回用户请求的数据。
  • 201 CREATED - [POST、PUT、PATCH]:用户新建或修改数据成功。
  • 204 NO CONTENT - [DELETE]:用户删除数据成功。
  • 401 Unauthorized - [ * ]:表示用户没有权限(令牌、用户名、密码错误)。
  • 403 Forbidden - [ * ]:表示用户得到授权(与401错误相对),但是访问是被禁止的,比如管理员权限操作。
  • 404 NOT FOUND - [ * ]:用户发出的请求真的的是不存在的记录,服务器没有进行操作,也就是常见的404页面。
  • 500 INTERNAL SERVER ERROR - [ * ]:服务器内部错误.
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,227评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,755评论 1 298
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,899评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,257评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,617评论 3 288
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,757评论 1 221
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,982评论 2 315
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,715评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,454评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,666评论 2 249
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,148评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,512评论 3 258
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,156评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,112评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,896评论 0 198
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,809评论 2 279
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,691评论 2 272

推荐阅读更多精彩内容

  • 总方针 构建易于理解和使用的RESTful接口。 接口应该是直观的,调用者可以通过接口来获得系统或应用程序中所有业...
    nikytwo阅读 1,847评论 0 3
  • 把api放在专属域名下,要带版本号 api的url中应该只有名词,和数据库的表或文档资源相对应;对资源(colle...
    YouKnowznM阅读 394评论 0 0
  • REST 是面向资源的,这个概念非常重要,而资源是通过 URI 进行暴露。 REST API 是基于 HTTP的,...
    RolexOO阅读 8,355评论 1 1
  • 概念 本质:一种软件架构风格 核心:面向资源设计的API 解决问题: 降低开发的复杂性 提高系统的可伸缩性 ...
    114105lijia阅读 1,926评论 0 0
  • 版本(Versioning) 所有的API必须保持向后兼容,必须在引入新版本API的同时确保旧版本API仍...
    皮皮杂谈阅读 1,961评论 0 10