文档章节

【转】URI设计原则,你设计的API做到了么?

AllenOR灵感
 AllenOR灵感
发布于 2017/09/10 01:26
字数 456
阅读 2
收藏 0
点赞 0
评论 0

咱们设计的REST API真的nice么?

优雅型:http://api.exapmle.com/louvre/da-vinci/mona-lisa
卢浮宫/达芬奇/蒙娜丽莎
中庸型:http://58.com/bj/ershou/310976
北京/二手频道/帖子ID
谢特型:http://api.example.com/68dd0-a9d3-11e0-9f1c
不知道什么鬼

本文将分享URI设计的一些原则。

1. URI的末尾不要添加“/”

多一个斜杠,语义完全不同,究竟是目录,还是资源,还是不确定而多做一次301跳转?

负面case:http://api.canvas.com/shapes/
正面case:http://api.canvas.com/shapes

2. 使用“-”提高URI的可读性

目的是使得URI便于理解,用“-”来连接单词

正面case:http://api.example.com/blogs/my-first-post

3. 禁止在URL中使用“_”

目的是提高可读性,“_”可能被文本查看器中的下划线特效遮蔽

负面case:http://api.example.com/blogs/my_first_post
别争,看到效果就明白了

4. 禁止使用大写字母

RFC 3986中规定URI区分大小写,但别用大写字母来为难程序员了,既不美观,又麻烦

负面case:http://api.example.com/My-Folder/My-Doc
正面case:http://api.example.com/my-folder/my-doc

5. 不要在URI中包含扩展名

应鼓励REST API客户端使用HTTP提供的格式选择机制Accept request header

正面case:http://58.com/bj/ershou/310976
负面case:http://58.com/bj/ershou/310976x.shtml

6. 建议URI中的名称使用复数

额,楼主不知道为何会有这么奇怪的建议

正面case:http://api.college.com/students/3248234/courses
负面case:http://api.college.com/student/3248234/course

最后,给后端研发工程师一个建议:清晰优雅的 RESTful API是为调用者编写的,别无脑随意定义一些shit一样的URI给移动/前端工程师使用,小心生命有危险。

原文:http://blog.restcase.com/7-rules-for-rest-api-uri-design/
作者:Guy Levin


来源:架构师之路

本文转载自:http://www.jianshu.com/p/0805a2c672e5

共有 人打赏支持
AllenOR灵感
粉丝 10
博文 2634
码字总数 82983
作品 0
程序员
REST风格的一点理解

REST的全称是表述性状态转移,它是一种架构设计风格。状态转移说的是在客户端和服务器端之间转移代表资源状态的表述 REST的主要原则包括:URL表示资源、HTTP方法表示操作。GET/POST/PUT/DELE...

技术小牛人
2017/11/01
0
0
Koa2实战练手(一)------ 学习RESTful API

Koa 是下一代的 Node.js 的 Web 框架。由 Express 团队设计。目的是提供一个更小型、更富有表现力、更可靠的 Web 应用和 API 的开发基础。 随着Nodejs新版本正式支持了async和await特性,Koa...

Jack088
06/12
0
0
REST风格的原则

一个好的RESTful API,应该具备以下特征: 这个API应该是对浏览器友好的,能够很好地融入Web,而不是与Web格格不入。 浏览器是最常见和最通用的REST客户端。好的RESTful API应该能够使用浏览...

吞吞吐吐的
2017/09/13
0
0
REST 风格的 Web 服务入门指南和 (重要)REST关键原则

提醒:想掌握并理解REST风格的Web服务,必须要熟悉HTTP协议,不能光知道GET/POST两种方式.详细请看: http://my.oschina.net/zhaoqian/blog/90315 首先向看一下REST在JavaEE里的规范JAX-RS. Jav...

Zhao-Qian
2012/11/19
0
4
(转)理解RESTful架构

越来越多的人开始意识到,网站即软件,而且是一种新型的软件。 这种"互联网软件"采用客户端/服务器模式,建立在分布式体系上,通过互联网通信,具有高延时(high latency)、高并发等特点。 ...

最王座
2016/07/14
30
0
[转]HTTP幂等性概念和应用

基于HTTP协议的Web API是时下最为流行的一种分布式服务提供方式。无论是在大型互联网应用还是企业级架构中,我们都见到了越来越多的SOA或RESTful的Web API。为什么Web API如此流行呢?我认为...

穿越星辰
2011/06/27
0
0
(转)使用JAX-RS简化REST应用开发

REST 简介 REST 是英文 Representational State Transfer 的缩写,有中文翻译为“具象状态传输”。REST 这个术语是由 Roy Fielding 在他的博士论文 《 Architectural Styles and the Design ...

最王座
2016/07/14
29
0
初识---转理解RESTful架构

越来越多的人开始意识到,网站即软件,而且是一种新型的软件。 这种"互联网软件"采用客户端/服务器模式,建立在分布式体系上,通过互联网通信,具有高延时(high latency)、高并发等特点。 ...

DanyCoder
03/26
0
0
如何设计出用户喜爱的API

原文:User experience design for APIs 作者:Francois Chollet 译者:夜风轻扬 译者注:什么样的API才是好的API?如何开发出用户乐于使用的API?请阅读下文。 编写代码不仅仅是人与电脑间的...

dev_csdn
2017/12/11
0
0
SOAP webserivce 和 RESTful webservice 对比及区别

摘要: 简单对象访问协议(Simple Object Access Protocol,SOAP)是一种基于 XML 的协议,可以和现存的许多因特网协议和格式结合使用,包括超文本传输协议(HTTP),简单邮件传输协议(SMT...

huojiao2006
2017/02/27
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

rabbitmq学习记录(六)交换机Exchange-direct

实现功能:一条消息发送给多个消费者 交换机模式:direct 相比于之前的fanout模式,可以进一步的筛选获取消息的消费者。 fanout模式下,只要消费者监听的队列,已经与接收生产者消息的交换机...

人觉非常君
18分钟前
0
0
Java 之 枚举

Java 中声明的枚举类,均是 java.lang.Enum 类的子类,Enun 类中的常用方法有: name() 返回枚举对象名称 ordinal() 返回枚举对象下标 valueOf(Class enumType, String name) 转换枚举对象 ...

绝世武神
26分钟前
0
0
使用爬虫实现代理IP池之放弃篇

啥叫代理IP以及代理IP池 概念上的东西网上搜索一下就好了,这里简单科普一下(大部分会读这篇文章的人,基本是不需要我来科普的),白话说就是能联网并提供代理访问互联网的服务器,它提供的...

一别丶经年
42分钟前
0
0
sqoop导入数据到Base并同步hive与impala

使用Sqoop从MySQL导入数据到Hive和HBase 及近期感悟 基础环境 Sqool和Hive、HBase简介 Sqoop Hive HBase 测试Sqoop 使用Sqoop从MySQL导入数据到Hive 使用复杂SQL 调整Hive数据类型 不断更新 ...

hblt-j
今天
0
0
Dart 服务端开发 文件上传

clent端使用angular组件 upload_component.html form id="myForm" method="POST" enctype="multipart/form-data"> <input type="file" name="fileData"> <!-- file field --></form>......

scooplol
今天
0
0
apache和tomcat同时开启,乱码问题

tomcat和apache同时开启,会走apache的转发,执行的是AJP/1.3协议。所以在tomcat的配置文件server中, <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" useBodyEncodingForU......

Kefy
今天
0
0
使用ssh-keygen和ssh-copy-id三步实现SSH无密码登录 和ssh常用命令

ssh-keygen 产生公钥与私钥对. ssh-copy-id 将本机的公钥复制到远程机器的authorized_keys文件中,ssh-copy-id也能让你有到远程机器的home, ~./ssh , 和 ~/.ssh/authorized_keys的权利 第一步...

xtof
今天
0
0
orcale 查询表结构

SELECT t.table_name, t.colUMN_NAME, t.DATA_TYPE || '(' || t.DATA_LENGTH || ')', t1.COMMENTS FROM User_Tab_Cols t, User_Col_Comments t1WHERE t.table_name......

wertwang
今天
0
0
华为nova3超级慢动作酷玩抖音,没有办法我就是这么强大

华为nova3超级慢动作酷玩抖音,没有办法我就是这么强大!华为nova3超级慢动作酷玩抖音,没有办法我就是这么强大! 在华为最新发布的nova 3手机上,抖音通过华为himedia SDK集成了60fps、超级...

华为终端开放实验室
今天
0
0
多 SSH Key 实现同一台服务器部署多 Git 仓库

本文以以下需求为背景,介绍详细的做法: 需在同一台服务器同时部署两个不同的 Github 仓库(对 Bitbucket 等 git 服务同样适用) root 用户可在远程登录 SSH 后附上预期的 SSH Key 进行 gi...

yeahlife
今天
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部