RESTful API|学习笔记

简介: 快速学习RESTful API

开发者学堂课程【高校精品课-厦门大学 -JavaEE 平台技术RESTful API学习笔记,与课程紧密联系,让用户快速学习知识

课程地址:https://developer.aliyun.com/learning/course/80/detail/15909


RESTful API

 

内容介绍:

一、实操演示

二、如何描述资源

三、JSON 的特性

 

一、restful 的三大特征

RESTful API 是一种网络应用程序接口的设计风格。

restful 用资源模型的方式来描述业务接口,其最主要的目的是让整个接口的描述更加容易理解,具备自解释性。

image.png

而且这样的描述方式可以让程序员或者使用者很方便的找到某个接口是否已经定义过,从而极大的提升了这个接口的应用性和可维护性,RESTful 接口最基本的特征为其面向资源,资源是构成应用系统最基本的概念。

其定义和之前在领域模型中所说的领域概念是同样的含义。restful 的接口中使用一个 url 代表一种资源,那在这种资源上是可以去进行若干操作的,restful 的操作依赖于 HTTP 的协议,也就是其利用 HTTP 协议的五种操作:get、put、delete、posh这五种操作来形成对资源的相关操作,在 restful 接口中所有的信息可以用 XM 或者 JSON 来表述,由于 JSON 的表述更加简短,而且具备人的可读性,所以目前来说 restful 接口基本会采用 JSON 这样的表述方式。这就是 restful 风格的最基本的三个特征:面向资源、依靠 HTTP 操作、使用 JSON 方式来表述。

 

二、如何描述资源

Restful 的资源模型可以支持单个资源对象,资源的对象和资源的集合对象以及可以表述资源之间的重组关系。上文提到 restful 的 API 是使用 url 来表示资源的,这里通过例子来了解应该怎样用 url 来表述在应用圈中的资源。

例如要描述在系统中的商品,可以用https://demo.xmu.edu.cn来表示这样的系统,在此系统里的资源、商品,这里就使用其路径(goods)来表示,所以这样的 url 可以表述在系统中的所有商品。品牌也同样可以使用

https://demo.xmu.edu.cn/brands来表述在系统中的品牌,商品分类也可以用同样的 url ,只需要替换路径为 categories来表示商品的分类。

一般情况下与描述领域模型一样,这里使用名词来描述资源,所以在资源中不会使用动词。为了使得其表述简单,描述的资源都是多个资源,所以一般会用复数形式来描述资源。

image.png

比如说使用 categories 描述所有的一级分类,如果要描述说在系统中的一个分类,就使用 categories/1来表示ID为1的一级商品分类。如果是二级分类,可以使用

categories/1/subcategories 表示ID为1的一级商品分类下的所有二级分类。

如果是其中某一个二级分类,可以直接使用subcategories/2表示ID为2的二级分类。如果想描述在二级分类下的所有商品,因为商品在分类底下,可以使用

subcategories/2/goods 来表示 ID 为2的二级商品分类下的所有商品。

一级分类下的所有商品,可以使用 categories/1/goods 来表示在一级分类下的所有商品,在电子商城系统中,一级分类下其实是没有商品的,总共的分类也就是采用两级分类的方式,其实所有的商品其实都是在二级分类底下, categories/1/goods 则表示在 ID 为1的一级商品分类下的所有的二级分类里的商品,所以说其是非常多商品的集合,那同样如果需要拿到单独的商品,可以使用

goods /ID,也就是例如使用 goods/5在系统中得到 ID 为5的商品。

 

三、JSON 的特性

JSON 是restful API用来进行数据交换的格式,也就是资源的属性值。资源的内容是用 JSON 来描述的,JSON 是一种完全独立于编程语言,用文本方式来描述数据的一种格式。JSON 所具备的最大的特征在于其便于人去理解的同时,也方便于机器去解析或者生成。而且由于 JSON 的描述是相对比较简短,所以说其有利于提高网络传输的效率。所以今天在 restful 的风格中大量使用 JSON 作为数据描述的语言。JSON 构成的值可以由对象、数组、数字和字符串,以及两个波尔值 force true 还有空来构成。

image.png

以一个对象为例,要描述一个用户的信息,以及其住址,那用户的“name”属性是John,“age”属性是18,其地址是另外对象,address属性为“country”:“China” “zip-code”也就是邮编属性为10000,用这样的 JSON 字串,可以用

很短的长度来描述出来人可以理解,机器也可以解析的这样的信息。

大家可以看到对象全是用{}来扩起来的,另外其也可以用来表示数组,数组直接就是将值放在里面,比如说一串整数的数组用【】扩起来,直接把值放在里面,不需要再放属性的名称。这样的一种方式可以看出使用 JSON 既简短又便于被人和机器

理解。这也就是为什么 restful 风格会采用 JSON 的方式来描述资源。

相关文章
|
1月前
|
JSON API 数据库
解释如何在 Python 中实现 Web 服务(RESTful API)。
解释如何在 Python 中实现 Web 服务(RESTful API)。
25 0
|
4天前
|
安全 Java API
RESTful API设计与实现:Java后台开发指南
【4月更文挑战第15天】本文介绍了如何使用Java开发RESTful API,重点是Spring Boot框架和Spring MVC。遵循无状态、统一接口、资源标识和JSON数据格式的设计原则,通过创建控制器处理HTTP请求,如示例中的用户管理操作。此外,文章还提及数据绑定、验证、异常处理和跨域支持。最后,提出了版本控制、安全性、文档测试以及限流和缓存的最佳实践,以确保API的稳定、安全和高效。
|
7天前
|
小程序 前端开发 API
小程序全栈开发中的RESTful API设计
【4月更文挑战第12天】本文探讨了小程序全栈开发中的RESTful API设计,旨在帮助开发者理解和掌握相关技术。RESTful API基于REST架构风格,利用HTTP协议进行数据交互,遵循URI、客户端-服务器架构、无状态通信、标准HTTP方法和资源表述等原则。在小程序开发中,通过资源建模、设计API接口、定义资源表述及实现接口,实现前后端高效分离,提升开发效率和代码质量。小程序前端利用微信API与后端交互,确保数据流通。掌握这些实践将优化小程序全栈开发。
|
17天前
|
前端开发 Java API
构建RESTful API:Java中的RESTful服务开发
【4月更文挑战第3天】本文介绍了在Java环境中构建RESTful API的重要性及方法。遵循REST原则,利用HTTP方法处理资源,实现CRUD操作。在Java中,常用框架如Spring MVC简化了RESTful服务开发,包括定义资源、设计表示层、实现CRUD、考虑安全性、文档和测试。通过Spring MVC示例展示了创建RESTful服务的步骤,强调了其在现代Web服务开发中的关键角色,有助于提升互操作性和用户体验。
构建RESTful API:Java中的RESTful服务开发
|
20天前
|
XML JSON 安全
谈谈你对RESTful API设计的理解和实践。
RESTful API是基于HTTP协议的接口设计,通过URI标识资源,利用GET、POST、PUT、DELETE等方法操作资源。设计注重无状态、一致性、分层、错误处理、版本控制、文档、安全和测试,确保易用、可扩展和安全。例如,`/users/{id}`用于用户管理,使用JSON或XML交换数据,提升系统互操作性和可维护性。
14 4
|
22天前
|
安全 API 开发者
构建高效可扩展的RESTful API服务
在数字化转型的浪潮中,构建一个高效、可扩展且易于维护的后端API服务是企业竞争力的关键。本文将深入探讨如何利用现代后端技术栈实现RESTful API服务的优化,包括代码结构设计、性能调优、安全性强化以及微服务架构的应用。我们将通过实践案例分析,揭示后端开发的最佳实践,帮助开发者提升系统的响应速度和处理能力,同时确保服务的高可用性和安全。
25 3
|
29天前
|
缓存 前端开发 API
构建高效可扩展的RESTful API:后端开发的最佳实践
【2月更文挑战第30天】 在现代Web应用和服务端架构中,RESTful API已成为连接前端与后端、实现服务间通信的重要接口。本文将探讨构建一个高效且可扩展的RESTful API的关键步骤和最佳实践,包括设计原则、性能优化、安全性考虑以及错误处理机制。通过这些实践,开发者可以确保API的健壮性、易用性和未来的可维护性。
|
30天前
|
API 开发者 UED
深入探讨RESTful API设计原则及最佳实践
在当今互联网时代,RESTful API已成为各种软件系统之间进行通信的重要方式。本文将从资源定义、URI设计、HTTP方法选择、状态码规范等方面深入探讨RESTful API设计的原则与最佳实践,帮助开发者更好地构建高效、健壮的API。
|
1月前
|
JSON Java API
Springboot项目中如何设计一个规范的统一的Restful API 响应框架?
Springboot项目中如何设计一个规范的统一的Restful API 响应框架?
22 1
|
1月前
|
XML JSON API
通过Flask框架创建灵活的、可扩展的Web Restful API服务
通过Flask框架创建灵活的、可扩展的Web Restful API服务