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

目录
打赏
0
0
0
0
55
分享
相关文章
RESTful与GraphQL:电商API接口设计的技术细节与适用场景
本文对比了RESTful与GraphQL这两种主流电商API接口设计方案。RESTful通过资源与HTTP方法定义操作,简单直观但可能引发过度或欠获取数据问题;GraphQL允许客户端精确指定所需字段,提高灵活性和传输效率,但面临深度查询攻击等安全挑战。从性能、灵活性、安全性及适用场景多维度分析,RESTful适合资源导向场景,GraphQL则适用于复杂数据需求。实际开发中需根据业务特点选择合适方案,或结合两者优势,以优化用户体验与系统性能。
Go语言网络编程:使用 net/http 构建 RESTful API
本章介绍如何使用 Go 语言的 `net/http` 标准库构建 RESTful API。内容涵盖 RESTful API 的基本概念及规范,包括 GET、POST、PUT 和 DELETE 方法的实现。通过定义用户数据结构和模拟数据库,逐步实现获取用户列表、创建用户、更新用户、删除用户的 HTTP 路由处理函数。同时提供辅助函数用于路径参数解析,并展示如何设置路由器启动服务。最后通过 curl 或 Postman 测试接口功能。章节总结了路由分发、JSON 编解码、方法区分、并发安全管理和路径参数解析等关键点,为更复杂需求推荐第三方框架如 Gin、Echo 和 Chi。
从业务需求到技术栈:电商API选型RESTful还是GraphQL?这5个维度帮你决策
在数字经济时代,电商平台的竞争已延伸至用户体验与系统效能。作为连接前后端及各类服务的核心,API接口的架构设计至关重要。本文对比RESTful与GraphQL两大主流方案,从电商场景出发,分析两者的技术特性、适用场景与选型逻辑,帮助开发者根据业务需求做出最优选择。
Understanding RESTful API and Web Services: Key Differences and Use Cases
在现代软件开发中,RESTful API和Web服务均用于实现系统间通信,但各有特点。RESTful API遵循REST原则,主要使用HTTP/HTTPS协议,数据格式多为JSON或XML,适用于无状态通信;而Web服务包括SOAP和REST,常用于基于网络的API,采用标准化方法如WSDL或OpenAPI。理解两者区别有助于选择适合应用需求的解决方案,构建高效、可扩展的应用程序。
Python 高级编程与实战:构建 RESTful API
本文深入探讨了使用 Python 构建 RESTful API 的方法,涵盖 Flask、Django REST Framework 和 FastAPI 三个主流框架。通过实战项目示例,详细讲解了如何处理 GET、POST 请求,并返回相应数据。学习这些技术将帮助你掌握构建高效、可靠的 Web API。
深入浅出Node.js:从零开始构建RESTful API
在数字化时代的浪潮中,后端开发作为连接用户与数据的桥梁,扮演着至关重要的角色。本文将引导您步入Node.js的奇妙世界,通过实践操作,掌握如何使用这一强大的JavaScript运行时环境构建高效、可扩展的RESTful API。我们将一同探索Express框架的使用,学习如何设计API端点,处理数据请求,并实现身份验证机制,最终部署我们的成果到云服务器上。无论您是初学者还是有一定基础的开发者,这篇文章都将为您打开一扇通往后端开发深层知识的大门。
157 12
深入理解RESTful API设计原则与实践
在现代软件开发中,构建高效、可扩展的应用程序接口(API)是至关重要的。本文旨在探讨RESTful API的核心设计理念,包括其基于HTTP协议的特性,以及如何在实际应用中遵循这些原则来优化API设计。我们将通过具体示例和最佳实践,展示如何创建易于理解、维护且性能优良的RESTful服务,从而提升前后端分离架构下的开发效率和用户体验。
构建高效RESTful API的后端实践指南####
本文将深入探讨如何设计并实现一个高效、可扩展且易于维护的RESTful API。不同于传统的摘要概述,本节将直接以行动指南的形式,列出构建RESTful API时必须遵循的核心原则与最佳实践,旨在为开发者提供一套直接可行的实施框架,快速提升API设计与开发能力。 ####
深入理解RESTful API设计原则
在数字化时代,API已成为连接不同软件应用的桥梁。本文旨在探讨RESTful API设计的基本原则和最佳实践,帮助开发者构建高效、可扩展的网络服务接口。通过解析REST架构风格的核心概念,我们将了解如何设计易于理解和使用的API,同时保证其性能和安全性。
|
8月前
|
深入理解RESTful API设计原则
在现代软件开发中,RESTful API已成为前后端分离架构下不可或缺的通信桥梁。本文旨在探讨RESTful API的核心设计原则,包括资源导向、无状态、统一接口、以及可缓存性等,并通过实例解析如何在实际应用中遵循这些原则来构建高效、可维护的API接口。我们将深入分析每个原则背后的设计理念,提供最佳实践指导,帮助开发者优化API设计,提升系统整体性能和用户体验。
199 0
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等

登录插画

登录以查看您的控制台资源

管理云资源
状态一览
快捷访问