前端API规范

## 资源(Resources) 

REST的名称"表现层状态转化"中,省略了主语。"表现层"其实指的是"资源"(Resources)的"表现层"。
所谓"资源",就是网络上的一个实体,或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的实在。你可以用一个URI(统一资源定位符)指向它,每种资源对应一个特定的URI。要获取这个资源,访问它的URI就可以,因此URI就成了每一个资源的地址或独一无二的识别符。

## HTTP 谓词

RESTful Web API采用了同一的接口,所以其成员体现为针对同一资源的操作。对于Web来说,针对资源的操作通过HTTP方法来体现。

1. C (create) -  POST   新增一个资源
1. R (retrieve) -  GET   读取资源
1. U (update) - PUT   更新资源
1. D (delete) - DELETE  删除资源

## HTTP 状态码

针对客户端向Web服务器发送的任意一个HTTP请求,不论在何种情况下得到一个响应,每个响应均具有一个由3位数字表示的状态码和相应的描述文字。不同数值的状态码体现了不同类型的响应状态,W3C对响应状态码的范围作了如下的规范。

- 100~199:信息状态码,代表请求已被接受,需要继续处理。
- 200~299:成功状态码,代表请求已成功被服务器接收、理解、并接受。
- 300~399:重定向状态码,代表需要客户端采取进一步的操作才能完成请求。
- 400~499:客户端错误状态码,代表了客户端看起来可能发生了错误,妨碍了服务器的处理。
- 500~599:服务器错误状态码,代表了服务器在处理请求的过程中有错误或者异常状态发生,也有可能是服务器意识到以当前的软硬件资源无法完成对请求的处理。


## 返回结果

- 当 http 状态为 20X,一般为 200 时,既认定当前请求成功,返回结果为正确业务数据
- 当 http 状态为 4XX,一般为 400 时,既认定当前请求出现异常,其返回结果为异常原因。401表示认证失败
- 当 http 状态为 5XX,  其中500服务器内部错误

 ### 单个资源

     //单个资源
       {
            id:11,                  //int
            name:'aaa',             //string
           createTime:1231233000,  //datetime
           account:222.21,         //float
       }

      ### 数组资源

```javascript
    //列表资源
    [
        {id:1,name:"张三"},
        {id:2,name:"李四"},
        {id:3,name:"王五"},
    ]


    //列表资源带分页
    {
        count:3,
        list:[
            {id:1,name:"张三"},
            {id:2,name:"李四"},
            {id:3,name:"王五"},
        ]
    }   
### 异常返回

> HTTP:400 时,使用以下格式
    //异常返回
    {
        message:'输入参数有误',
        code:'1001'
    }
## URL
***
 1. URI不要包含动词
 1. URI不要包含动词
 1. URI不要包含动词

  - 重要的说3遍


### 单资源( singular-resourceX )

   > url样例: /order

   1. GET – 返回一个新的order

   1. POST- 创建一个新的order,从post请求携带的内容获取值。

### 单资源带id(singular-resourceX/{id} )

> URL样例:order/1 ( order即指那个单独的资源X )

1. GET – 返回id是1的order

1. DELETE – 删除id是1的order

1. PUT – 更新id是1的order,order的值从请求的内容体中获取。

### 复数资源(plural-resourceX/)

 > URL样例: /orders

 1. GET – 返回所有orders

 ### 复数资源查找(plural-resourceX/search)

 > URL样例: /orders/search?name=123

 1. GET – 返回所有满足查询条件的order资源。(实例查询,无关联) – order名字等于123的。

### 单数资源(singular-resourceX/{id}/pluralY)

> URL样例: /order/1/items/ (这里order即为资源X,items是复数资源Y)

1. GET – 将返回所有与order id 是1关联的items。

### singular-resourceX/{id}/singular-resourceY/

 > URL样例:/order/1/item/

 1. GET – 返回一个瞬时的新的与order id是1关联的item实例。

 2. POST – 创建一个与order id 是1关联的item实例。Item的值从post请求体中获取。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 195,980评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,422评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,130评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,553评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,408评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,326评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,720评论 3 386
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,373评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,678评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,722评论 2 312
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,486评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,335评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,738评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,283评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,692评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,893评论 2 335

推荐阅读更多精彩内容