发帖

【优惠升级】华秋PCB首单最高立减100元，SMT免费贴片！！！

[经验]

restful api设计规范

2018-3-26 16:26:24

2957 设计规范

0

Restful API是目前比较成熟的一套互联网应用程序的API设计理念，Rest是一组架构约束条件和原则，如何Rest约束条件和原则的架构，我们就称为Restful架构，Restful架构具有结构清晰、符合标准、易于理解以及扩展方便等特点，受到越来越多网站的采用！

Restful API接口规范包括以下部分：

一、协议

API与用户的通信协议，总是使用HTTPs协议。

二、域名

应该尽量将API部署在专用域名之下，如https://api.oldboyedu.com；如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下，如https://oldboyedu.com/api/。

三、版本

可以将版本号放在HTTP头信息中，也可以放入URL中，如https://api.oldboyedu.com/v1/

四、路径

路径是一种地址，在互联网上表现为网址，在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数，如https://api.oldboyedu.com/v1/students。

五、HTTP动词

对于资源的具体操作类型，由HTTP动词表示，HTTP动词主要有以下几种，括号中对应的是SQL命令。

1. GET（SELECT）：从服务器取出资源（一项或多项）；

2. POST（CREATE）：在服务器新建一个资源；

3. PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）；

4. PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）；

5. DELETE（DELETE）：从服务器删除资源；

6. HEAD：获取资源的元数据；

7. OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

六、过滤信息

如果记录数量很多，服务器不可能都将它们返回给用户，API会提供参数，过滤返回结果，常见的参数有：

1. ?limit=20：指定返回记录的数量为20；

2. ?offset=8：指定返回记录的开始位置为8；

3. ?page=1&per_page=50：指定第1页，以及每页的记录数为50；

4. ?sortby=name&order=asc：指定返回结果按照name属性进行升序排序；

5. ?animal_type_id=2：指定筛选条件。

七、状态码

服务器会向用户返回状态码和提示信息，以下是常用的一些状态码：

1. 200 OK - [GET]：服务器成功返回用户请求的数据；

2. 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功；

3. 202 Accepted -

：表示一个请求已经进入后台排队（异步任务）；

4. 204 NO CONTENT - [DELETE]：用户删除数据成功；

5. 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作；

6. 401 Unauthorized -

：表示用户没有权限（令牌、用户名、密码错误）；

7. 403 Forbidden -

表示用户得到授权（与401错误相对），但是访问是被禁止的；

8. 404 NOT FOUND -

：用户发出的请求针对的是不存在的记录，服务器没有进行操作；

9. 406 Not Acceptable - [GET]：用户请求的格式不可得；

10. 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的；

11. 422 Unprocesable entity -[POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误；

12. 500 INTERNAL SERVER ERROR -

：服务器发生错误，用户将无法判断发出的请求是否成功。

八、错误处理

如果状态码是4xx，就会向用户返回出错信息，一般来说，返回的信息中将error作为键名，出错信息作为键值。

九、返回结果

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

1. GET /collection：返回资源对象的列表（数组）；

2. GET /collection/resource：返回单个资源对象；

3. POST /collection：返回新生成的资源对象；

4. PUT /collection/resource：返回完整的资源对象；

5. PATCH /collection/resource：返回完整的资源对象；

6. DELETE /collection/resource：返回一个空文档。

十、HypermediaAPI

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

以上是Restful API设计应遵循的十大规范，除此之外，Restful API还需注意身份认证应该使用OAuth 2.0框架，服务器返回的数据格式，应该尽量使用JSON，避免使用XML。

只看该作者 淘帖0 举报

相关推荐

只有小组成员才能发言，加入小组>>

1700个成员聚集在这个小组

精选推荐

「含关键代码」基于AM3352/AM3354/AM3359的Linux开发案例分享

4893 浏览 0 评论
丁光宇：善用“兵法”，突破Linux项目开发难点

87410 浏览 0 评论
【高手问答】如何做到精通linux技术？资深工程师带你突破难点

4724 浏览 2 评论
Linux常用必会60个命令实例详解

3619 浏览 2 评论
解读Linux ：先从创建一个文件夹用来存放jdk压缩文件开始

2482 浏览 0 评论

最新话题

热门话题

请教一个OUI相关问题

1998浏览 3评论
有没有大佬用过银河麒麟，进来聊聊

1284浏览 1评论
求解：aarch64交叉编译工具已经安装成功，环境变量已经配置，怎么将系统架构切换为ARM的架构

1342浏览 0评论
电脑和虚拟机可以互ping，电脑和开发板也可以互ping，但是虚拟机和开发板ping不通是什么原因

1234浏览 0评论
求助lpr连续打印图片的时候大概有8秒的延迟如何解决

1173浏览 0评论

创建小组步骤

创建小组创建自己的地盘
个性设置精心打造小组空间
邀请好友邀请好友加入我的小组
小组升级小组积分升级赢得社区推荐

创建属于自己的小组

快速回复 返回顶部 返回列表

关注微信公众号

电子发烧友网

电子发烧友论坛

社区合作: 刘勇; 联系电话：15994832713; 邮箱地址：liuyong@huaqiu.com

社区管理: elecfans短短; 微信：elecfans_666; 邮箱：users@huaqiu.com

【优惠升级】华秋PCB首单最高立减100元，SMT免费贴片！！！

返回 Linux论坛

回复

关闭

站长推荐 /6

快速回复 返回顶部 返回列表

- 技术社区: HarmonyOS技术社区

RISC-V MCU技术社区

FPGA开发者技术社区

- OpenHarmony开源社区: OpenHarmony开源社区

- 嵌入式论坛: ARM技术论坛

STM32/STM8技术论坛

嵌入式技术论坛

单片机/MCU论坛

RISC-V技术论坛

瑞芯微Rockchip开发者社区

FPGA|CPLD|ASIC论坛

DSP论坛

- 电路图及DIY: 电路设计论坛

DIY及创意

电子元器件论坛

专家问答

- 电源技术论坛: 电源技术论坛

无线充电技术

- 综合技术与应用: 机器人论坛

USB论坛

电机控制

模拟技术

音视频技术

综合技术交流

上位机软件（C/Python/Java等）

- 无线通信论坛: WIFI技术

蓝牙技术

天线|RF射频|微波|雷达技术

- EDA设计论坛: PCB设计论坛

DigiPCBA论坛

Protel|AD|DXP论坛

PADS技术论坛

Allegro论坛

multisim论坛

proteus论坛|仿真论坛

KiCad EDA 中文论坛

DFM|可制造性设计论坛

- 测试测量论坛: LabVIEW论坛

Matlab论坛

测试测量技术

传感技术

- 招聘/交友/外包/交易/杂谈: 项目外包

供需及二手交易

工程师杂谈|交友

招聘|求职|工程师职场

- 官方社区: 发烧友官方/活动

华秋商城

华秋电路

time

recommend

hot

post

—
—
—

版
块
导
航