[01] 浅谈RESTful风格的API

1、什么是RESTful风格的API

REST,即Representational State Transfer,可以理解为“(资源的)表现层状态转化”。

在网络上,我们通过浏览器输入url,来访问和获取到所需要的资源。这里的url,是对资源位置的定位描述,其实也是一种资源的具体呈现的方式,即这里所说的“表现层”。我们访问资源的过程涉及到数据和状态的变化,“建立在表现层(url)基础上使资源状态发生变化”,也即“表现层状态转化(REST)”了。

符合REST规范的API,则称之为RESTful风格的API,再大白话一点,能让我们“通过API接口名称就能明白它的作用”,它优雅、规范、易懂,省去了许多无意义的沟通和文档。核心规范是什么呢?使用HTTP协议中的四种不同请求方式,来代表四种不同的动词操作:GET用来获取资源;POST用来新建资源;PUT用来更新资源;DELETE用来删除资源。

具体一点来说,RESTful API有如下特点

  • 基于“资源”,数据也好,服务也好,在RESTful设计中一切都是资源
  • 每个URL表示一种资源
  • URL语义清晰明确,不出现动词,只有名词(操作的动词是通过请求方式来表示)
  • 使用HTTP的 POST、DELETE、PUT、GET 来表示对资源的增删改查
  • 尽量使用JSON而不是XML
  • 应该将API的版本号放入URL

举例来说,某API提供动物园(zoo)系统相关信息,则RESTful的API风格如下:

  • https://api.example.com/v1/zoos
  • https://api.example.com/v1/animals
  • https://api.example.com/v1/employees

再具体一点:

  • GET        /zoos:列出所有动物园
  • POST      /zoos:新建一个动物园
  • GET        /zoos/ID:获取某个指定动物园的信息
  • PUT        /zoos/ID:更新某个指定动物园的信息
  • GET        /zoos/ID/animals:列出某个指定动物园的所有动物
  • DELETE  /zoos/ID/animals/ID:删除某个指定动物园的指定动物

API同时也可以提供一些参数,用来过滤返回结果,常见参数如下:

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

上面来一个鲜活的例子,豆瓣图书相关的开发API

先看看这个链接,是什么作用?再试试直接访问(GET方式),返回的内容是什么?https://api.douban.com/v2/book/1220563

2、RESTful什么时候好用

对于开放的API,豆瓣、新浪微博、GitHub,好用,非常合适;对于内部开发,不好用。

基于资源型的RESTful API 接口粒度和返回结果过于的“粗”,它通常返回的都是完整的数据模型,这对于客户端非常不友好。但开放API之所以开放,就是因为它不知道你到底需要什么返回结果,既然不知道,那么我干脆都返回给你。这样的好处是通用,但客户端不好处理。你只需要一个字段,服务器却丢给你十几个,作为客户端开发者你怎么想?

内部开发由于需求非常明确,通常来说服务器是不应该简单粗暴的直接甩资源实体给客户端的。那RESTful API就不能接入到内部开发吗?当然不是,我们需要灵活一些借鉴RESTFul中的优点,来设计我们的内部API。那么如何简化,就需要自己去琢磨和体会了。

3、参考链接

原文地址:https://www.cnblogs.com/deng-cc/p/8331465.html

时间: 2024-08-02 09:06:04

[01] 浅谈RESTful风格的API的相关文章

PHP实现RESTful风格的API实例(一)

(关于Yii2的RESTful教程请看: Yii2框架RESTful API教程) 最近看了一些关于RESTful的资料,自己动手也写了一个RESTful实例,以下是源码 目录详情: restful/ Request.php 数据操作类 Response.php 输出类 index.php 入口文件 .htaccess 重写url Request.php :包含一个Request类,即数据操作类.接收到URL的数据后,根据请求URL的方式(GET|POST|PUT|PATCH|DELETE)对数

PHP实现RESTful风格的API实例(二)

接前一篇:PHP实现RESTful风格的API实例(一) Response.php :包含一个Request类,即输出类.根据接收到的Content-Type,将Request类返回的数组拼接成对应的格式,加上header后输出 <?php /** * 输出类 */ class Response { const HTTP_VERSION = "HTTP/1.1"; //返回结果 public static function sendResponse($data) { //获取数据

PHP实现RESTful风格的API实例(三)

接前一篇:PHP实现RESTful风格的API实例(二) .htaccess :重写URL,使URL以 /restful/class/1 形式访问文件 Options +FollowSymlinks RewriteEngine on # 重写规则 RewriteRule ^class$ index.php?class=all [nc,qsa] RewriteRule ^class/(\d+)$ index.php?class=$1 [nc,qsa] 在Apache的web目录下新建一个restf

PHP实现Restful风格的API(转)

Restful是一种设计风格而不是标准,比如一个接口原本是这样的: http://www1.qixoo.com/user/view/id/1表示获取id为1的用户信息,如果使用Restful风格,可以变成这样: http://www1.qixoo.com/user/1可以很明显的看出这样做的好处: 1.更简洁的URL,对程序员友好 2.不暴露内部代码结构,更安全 那么,如何实现这个接口呢?首先,我们需要接收到/user/1部分. $path = $_SERVER['PATH_INFO'];$ar

PHP实现Restful风格的API

Restful是一种设计风格而不是标准,比如一个接口原本是这样的: http://www1.qixoo.com/user/view/id/1表示获取id为1的用户信息,如果使用Restful风格,可以变成这样: http://www1.qixoo.com/user/1可以很明显的看出这样做的好处: 1.更简洁的URL,对程序员友好 2.不暴露内部代码结构,更安全 那么,如何实现这个接口呢?首先,我们需要接收到/user/1部分. $path = $_SERVER['PATH_INFO'];$ar

Yii2实现RESTful风格的API中要注意的坑

Yii2实现RESTful风格的API的流程如下:1.WEB前端(frontend)和后端(backend)的同级目录,新建一个文件夹,命名api,api中文件完全复制一份原始的backend中文件即可 2.需要修改common\config\bootstrap.php文件,对新建的应用增加alias别名 Yii::setAlias('@api', dirname(dirname(DIR)) . '/api'); 3.保证你的web服务器开启rewrite规则!配置apache或nginx!这里

springMvc中restful风格的api路径中把小数点当参数,SpringMvc中url有小数点

在springMvc web项目中restful风格的api路径中有小数点会被过滤后台拿不到最后一个小数点的问题, 有两种解决方案: 1:在api路径中加入:.+ @RequestMapping("/findByIp/{ip:.+}") public Object test(@PathVariable String ip) { System.out.println(ip); return ""; } 但这种方式在web服务中感觉太过于鸡肋 所以在springMvc.

测开大佬告诉你:如何5分钟快速创建restful风格的API接口-使用django restframework框架

一.思考?? 1.创建API接口难吗? 软件测试工程师: 只测过API接口, 从没创建过 应该需要掌握一门后端开发语言和后端开发框架吧!? 脑容量有限,想想就可怕 2.如何创建API接口呢? 使用Django restframework能快速创建符合restful风格的API接口 通过Django restframework框架提供的序列化器.视图集可轻轻松松实现 简单高效,学习成本低 二.搭建项目工程???? 1.创建项目 打开pycharm 创建项目 使用豆瓣源安装Django Django

restful 风格 web api规范

协议:http/https 域名 : http://api.example.com/xxx/xxx api: 标明api接口服务 xxx: 服务 xxx: 资源 版本控制: 一.使用MediaType,即在请求头header中做版本控制,数据格式等控制 想要获取的资源格式 GET /user/123456 HTTP/1.1 Accept: application/vnd.123456.user-v3+json 获取v3版userid为123456 的用户信息,返回资源格式为json 响应的文本格