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 的方式来描述资源。

相关文章
|
7天前
|
JSON Java API
如何设计可扩展的RESTful API?
如何设计可扩展的RESTful API?
|
1天前
|
安全 前端开发 API
深入理解RESTful API设计原则与实践
【7月更文挑战第14天】在数字化时代的浪潮中,后端开发扮演着至关重要的角色,而RESTful API作为现代Web服务通信的基石,其设计质量直接影响到应用的性能与可维护性。本文将通过剖析RESTful API的核心设计原则,结合实际案例,探讨如何构建高效、易于理解和扩展的API。我们将从资源定位、请求方法、状态码使用等方面入手,揭示良好API设计的秘诀,并分享一些最佳实践和常见陷阱,旨在指导开发者打造更加健壮和友好的后端服务接口。
|
7天前
|
JSON Java API
如何设计可扩展的RESTful API?
如何设计可扩展的RESTful API?
|
11天前
|
XML Java API
使用Java构建RESTful API的最佳实践
使用Java构建RESTful API的最佳实践
|
3天前
|
XML 缓存 API
深入理解RESTful API设计原则与最佳实践
【7月更文挑战第12天】本文将探索RESTful API设计的核心原则和实用的最佳实践。我们将从REST的基本概念入手,逐步深入到API设计的高级话题,如版本控制、状态码的正确使用以及如何提高API的安全性。此外,我们还将探讨一些常见的设计挑战和解决方案,以帮助开发者构建更加健壮、可维护和用户友好的后端服务。
|
7天前
|
Java API 数据库
使用Spring Boot构建RESTful API
使用Spring Boot构建RESTful API
|
7天前
|
开发框架 Java API
使用Spring Boot构建RESTful API的最佳实践
使用Spring Boot构建RESTful API的最佳实践
|
13天前
|
Java API 开发者
RESTful API设计与实现:Java开发者指南
RESTful API设计与实现:Java开发者指南
|
14天前
|
Java API Spring
Spring Boot中的RESTful API版本控制
Spring Boot中的RESTful API版本控制
|
14天前
|
缓存 API 数据安全/隐私保护
深入理解RESTful API设计原则与实践
在当今的软件开发领域,API已成为连接不同软件组件、服务及平台的关键接口。RESTful API,以其简洁性、可扩展性和易于使用的特点,被广泛应用于Web服务开发中。本文将通过数据导向和科学严谨的分析方法,探讨RESTful API的设计原则和实践应用,旨在为开发者提供一套系统化的方法论,以指导其构建更加高效、稳定且易于维护的API服务。