热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

[01]浅谈RESTful风格的API

1、什么是RESTful风格的APIREST,即RepresentationalStateTransfer,可以理解为“(资源的)表现层状态转化”。在网络上,我们通过浏览器输入ur

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、参考链接

  • REST与RESTFul API最佳实践
  • 理解RESTful架构
  • RESTful API 设计指南
  • 我所认为的RESTful API最佳实践


[01] 浅谈RESTful风格的API


推荐阅读
  • 本文介绍了OC学习笔记中的@property和@synthesize,包括属性的定义和合成的使用方法。通过示例代码详细讲解了@property和@synthesize的作用和用法。 ... [详细]
  • 知识图谱——机器大脑中的知识库
    本文介绍了知识图谱在机器大脑中的应用,以及搜索引擎在知识图谱方面的发展。以谷歌知识图谱为例,说明了知识图谱的智能化特点。通过搜索引擎用户可以获取更加智能化的答案,如搜索关键词"Marie Curie",会得到居里夫人的详细信息以及与之相关的历史人物。知识图谱的出现引起了搜索引擎行业的变革,不仅美国的微软必应,中国的百度、搜狗等搜索引擎公司也纷纷推出了自己的知识图谱。 ... [详细]
  • 《数据结构》学习笔记3——串匹配算法性能评估
    本文主要讨论串匹配算法的性能评估,包括模式匹配、字符种类数量、算法复杂度等内容。通过借助C++中的头文件和库,可以实现对串的匹配操作。其中蛮力算法的复杂度为O(m*n),通过随机取出长度为m的子串作为模式P,在文本T中进行匹配,统计平均复杂度。对于成功和失败的匹配分别进行测试,分析其平均复杂度。详情请参考相关学习资源。 ... [详细]
  • 本文介绍了lua语言中闭包的特性及其在模式匹配、日期处理、编译和模块化等方面的应用。lua中的闭包是严格遵循词法定界的第一类值,函数可以作为变量自由传递,也可以作为参数传递给其他函数。这些特性使得lua语言具有极大的灵活性,为程序开发带来了便利。 ... [详细]
  • Mac OS 升级到11.2.2 Eclipse打不开了,报错Failed to create the Java Virtual Machine
    本文介绍了在Mac OS升级到11.2.2版本后,使用Eclipse打开时出现报错Failed to create the Java Virtual Machine的问题,并提供了解决方法。 ... [详细]
  • 在说Hibernate映射前,我们先来了解下对象关系映射ORM。ORM的实现思想就是将关系数据库中表的数据映射成对象,以对象的形式展现。这样开发人员就可以把对数据库的操作转化为对 ... [详细]
  • 本文介绍了在SpringBoot中集成thymeleaf前端模版的配置步骤,包括在application.properties配置文件中添加thymeleaf的配置信息,引入thymeleaf的jar包,以及创建PageController并添加index方法。 ... [详细]
  • 本文详细介绍了Linux中进程控制块PCBtask_struct结构体的结构和作用,包括进程状态、进程号、待处理信号、进程地址空间、调度标志、锁深度、基本时间片、调度策略以及内存管理信息等方面的内容。阅读本文可以更加深入地了解Linux进程管理的原理和机制。 ... [详细]
  • 1,关于死锁的理解死锁,我们可以简单的理解为是两个线程同时使用同一资源,两个线程又得不到相应的资源而造成永无相互等待的情况。 2,模拟死锁背景介绍:我们创建一个朋友 ... [详细]
  • 后台获取视图对应的字符串
    1.帮助类后台获取视图对应的字符串publicclassViewHelper{将View输出为字符串(注:不会执行对应的ac ... [详细]
  • 本文介绍了通过ABAP开发往外网发邮件的需求,并提供了配置和代码整理的资料。其中包括了配置SAP邮件服务器的步骤和ABAP写发送邮件代码的过程。通过RZ10配置参数和icm/server_port_1的设定,可以实现向Sap User和外部邮件发送邮件的功能。希望对需要的开发人员有帮助。摘要长度:184字。 ... [详细]
  • 高质量SQL书写的30条建议
    本文提供了30条关于优化SQL的建议,包括避免使用select *,使用具体字段,以及使用limit 1等。这些建议是基于实际开发经验总结出来的,旨在帮助读者优化SQL查询。 ... [详细]
  • 在project.properties添加#Projecttarget.targetandroid-19android.library.reference.1..Sliding ... [详细]
  • CentOS 7部署KVM虚拟化环境之一架构介绍
    本文介绍了CentOS 7部署KVM虚拟化环境的架构,详细解释了虚拟化技术的概念和原理,包括全虚拟化和半虚拟化。同时介绍了虚拟机的概念和虚拟化软件的作用。 ... [详细]
  • 本文介绍了一种解析GRE报文长度的方法,通过分析GRE报文头中的标志位来计算报文长度。具体实现步骤包括获取GRE报文头指针、提取标志位、计算报文长度等。该方法可以帮助用户准确地获取GRE报文的长度信息。 ... [详细]
author-avatar
zsx2502853407
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有