什么是RESTful API，有什么特点

🕗 发布于 2024-11-22 15:24 restful 后端

RESTful API 概述

什么是 RESTful API？

RESTful API 是基于 Representational State Transfer（表现层状态转移）架构风格的 Web 服务接口。REST 是一种设计风格，而不是具体的协议或标准。它定义了一组约束和最佳实践，用于构建可扩展、可维护的 Web 服务。RESTful API 通过 HTTP 协议与客户端进行通信，使用标准的 HTTP 方法（如 GET、POST、PUT、DELETE 等）来操作资源。资源通过 URI（Uniform Resource Identifier）唯一标识，API 返回的数据格式通常是 JSON 或 XML。

RESTful API 的特点

无状态：
- 每次请求独立：RESTful API 是无状态的，即服务器不保存任何客户端的上下文信息。每次请求都必须包含所有必要的信息，以便服务器能够理解并处理请求。
- 优点：无状态性使得系统更易于扩展，因为每个请求都是独立的，可以分散到不同的服务器上处理。
客户端-服务器架构：
- 分离关注点：客户端负责用户界面和用户交互，服务器负责数据存储和业务逻辑。这种分离使得客户端和服务器可以独立演化，互不影响。
- 优点：提高了系统的可维护性和可扩展性。
统一接口：
- 资源标识：每个资源都有一个唯一的 URI，用于标识和访问该资源。
- 操作方法：使用标准的 HTTP 方法（GET、POST、PUT、DELETE 等）来操作资源。
- 自描述消息：每个请求和响应都包含足够的信息，使得客户端能够理解如何处理它们。
- 超媒体驱动：API 通过超媒体（如链接）提供导航和操作的指导，使得客户端能够发现和使用 API 的功能。
分层系统：
- 多层架构：RESTful API 可以通过多层架构来实现，每一层都提供特定的服务，如负载均衡、缓存、安全等。
- 优点：提高了系统的可扩展性和安全性。
缓存：
- 可缓存性：某些请求的结果可以被缓存，以减少服务器的负载和提高响应速度。
- 优点：通过缓存机制，可以显著提高系统的性能和响应时间。
按需代码（可选）：
- 动态代码下载：客户端可以从服务器下载代码或脚本，以扩展其功能。
- 优点：增加了系统的灵活性和可扩展性。

RESTful API 的作用

提供数据访问和操作接口

数据读取：通过 GET 方法，客户端可以请求服务器返回指定资源的数据。
数据创建：通过 POST 方法，客户端可以向服务器发送数据，创建新的资源。
数据更新：通过 PUT 或 PATCH 方法，客户端可以更新现有资源的数据。
数据删除：通过 DELETE 方法，客户端可以请求服务器删除指定的资源。

支持多种数据格式

JSON：JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，易于阅读和编写，广泛用于 RESTful API。
XML：XML（eXtensible Markup Language）是一种标记语言，适用于复杂的数据结构，但在现代应用中使用较少。
其他格式：RESTful API 也可以支持其他数据格式，如 YAML、CSV 等，以满足不同客户端的需求。

支持跨平台和跨语言

标准化协议：RESTful API 使用标准的 HTTP 协议，不受编程语言和平台的限制，可以被任何支持 HTTP 的客户端调用。
广泛适用：无论是 Web 应用、移动应用还是 IoT 设备，都可以通过 RESTful API 访问和操作数据。

提高系统的可扩展性和可维护性

无状态性：无状态性使得系统更容易扩展，因为每个请求都是独立的，可以分散到不同的服务器上处理。
模块化设计：RESTful API 的设计鼓励模块化和松耦合，使得系统更易于维护和扩展。

举例说明

示例 1：创建一个简单的 RESTful API

假设我们要创建一个简单的 RESTful API，用于管理用户信息。以下是实现步骤：

安装 Express：使用 npm 安装 Express。
```
npm install express
```

创建应用文件：创建一个名为 app.js 的文件，编写基本的 Express 应用代码。

const express = require('express');
const app = express();
const port = 3000;

// 解析 JSON 请求体
app.use(express.json());

// 模拟用户数据
let users = [
    { id: 1, name: 'John Doe', email: 'john@example.com' },
    { id: 2, name: 'Jane Smith', email: 'jane@example.com' }
];

// 获取所有用户
app.get('/api/users', (req, res) => {
    res.json(users);
});

// 获取单个用户
app.get('/api/users/:id', (req, res) => {
    const user = users.find(u => u.id === parseInt(req.params.id));
    if (!user) return res.status(404).send('User not found');
    res.json(user);
});

// 创建新用户
app.post('/api/users', (req, res) => {
    const newUser = {
        id: users.length + 1,
        name: req.body.name,
        email: req.body.email
    };
    users.push(newUser);
    res.status(201).json(newUser);
});

// 更新用户
app.put('/api/users/:id', (req, res) => {
    const user = users.find(u => u.id === parseInt(req.params.id));
    if (!user) return res.status(404).send('User not found');

    user.name = req.body.name || user.name;
    user.email = req.body.email || user.email;
    res.json(user);
});

// 删除用户
app.delete('/api/users/:id', (req, res) => {
    const userIndex = users.findIndex(u => u.id === parseInt(req.params.id));
    if (userIndex === -1) return res.status(404).send('User not found');

    users.splice(userIndex, 1);
    res.status(204).send();
});

// 启动服务器
app.listen(port, () => {
    console.log(`Server is running on http://localhost:${port}`);
});

运行应用：在终端中运行以下命令启动应用。
```
node app.js
```

测试 API：使用 Postman 或 curl 测试 API 的各个端点。

获取所有用户：
```
curl http://localhost:3000/api/users
```
获取单个用户：
```
curl http://localhost:3000/api/users/1
```

创建新用户：

curl -X POST -H "Content-Type: application/json" -d '{"name": "Alice Johnson", "email": "alice@example.com"}' http://localhost:3000/api/users

更新用户：

curl -X PUT -H "Content-Type: application/json" -d '{"name": "Alice Smith", "email": "alice.smith@example.com"}' http://localhost:3000/api/users/3

删除用户：

curl -X DELETE http://localhost:3000/api/users/3

示例 2：使用中间件和数据库

假设我们需要创建一个更复杂的 RESTful API，使用中间件和数据库来管理用户信息。以下是实现步骤：

安装依赖：使用 npm 安装 Express、body-parser 和 MongoDB 的驱动程序。
```
npm install express body-parser mongoose
```

连接数据库：在 app.js 中连接 MongoDB 数据库。

const express = require('express');
const bodyParser = require('body-parser');
const mongoose = require('mongoose');
const app = express();
const port = 3000;

// 连接 MongoDB
mongoose.connect('mongodb://localhost:27017/mydatabase', { useNewUrlParser: true, useUnifiedTopology: true })
  .then(() => console.log('Connected to MongoDB'))
  .catch(err => console.error('Failed to connect to MongoDB', err));

// 定义用户模型
const UserSchema = new mongoose.Schema({
    name: String,
    email: String
});

const User = mongoose.model('User', UserSchema);

// 使用 body-parser 中间件
app.use(bodyParser.json());

// 获取所有用户
app.get('/api/users', async (req, res) => {
    const users = await User.find();
    res.json(users);
});

// 获取单个用户
app.get('/api/users/:id', async (req, res) => {
    const user = await User.findById(req.params.id);
    if (!user) return res.status(404).send('User not found');
    res.json(user);
});

// 创建新用户
app.post('/api/users', async (req, res) => {
    const user = new User({
        name: req.body.name,
        email: req.body.email
    });
    await user.save();
    res.status(201).json(user);
});

// 更新用户
app.put('/api/users/:id', async (req, res) => {
    const user = await User.findById(req.params.id);
    if (!user) return res.status(404).send('User not found');

    user.name = req.body.name || user.name;
    user.email = req.body.email || user.email;
    await user.save();
    res.json(user);
});

// 删除用户
app.delete('/api/users/:id', async (req, res) => {
    const user = await User.findByIdAndDelete(req.params.id);
    if (!user) return res.status(404).send('User not found');
    res.status(204).send();
});

// 启动服务器
app.listen(port, () => {
    console.log(`Server is running on http://localhost:${port}`);
});

运行应用：在终端中运行以下命令启动应用。
```
node app.js
```
测试 API：使用 Postman 或 curl 测试 API 的各个端点，操作与示例 1 相同。

RESTful API 的应用场景

个人项目

个人博客：使用 RESTful API 可以快速创建一个功能完善的个人博客系统，包含文章发布、分类管理、评论系统等功能。
个人网站：创建一个展示个人作品和项目的网站，使用 RESTful API 处理动态内容和用户交互。

企业应用

电商平台：构建一个支持商品展示、购物车、订单管理等功能的电商平台，使用 RESTful API 处理复杂的业务逻辑和数据交互。
企业管理系统：开发一个企业内部管理系统，管理员工、项目、财务等信息，使用 RESTful API 提供 RESTful API 接口。

社交应用

社交网络：创建一个支持用户注册、登录、发布动态、私信等功能的社交网络应用，使用 RESTful API 处理多用户交互和数据管理。
论坛系统：开发一个支持发帖、回帖、点赞等功能的论坛系统，使用 RESTful API 处理多用户交互和数据管理。

API 服务

天气预报 API：构建一个提供天气预报数据的 API 服务，使用 RESTful API 处理 HTTP 请求和响应。
支付网关：开发一个支持多种支付方式的支付网关，使用 RESTful API 处理支付请求和回调。

总结

RESTful API 是一种基于 REST 架构风格的 Web 服务接口，通过使用标准的 HTTP 方法和 URI 来操作资源，具有无状态、客户端-服务器架构、统一接口、分层系统、缓存和按需代码等特点。RESTful API 提供了数据访问和操作的接口，支持多种数据格式，适用于跨平台和跨语言的应用，提高了系统的可扩展性和可维护性。无论是个人项目还是企业级应用，RESTful API 都是一个值得推荐的选择。

进一步阅读和学习

官方文档：RESTful API 没有官方文档，但有许多权威的书籍和文章，如《RESTful Web Services》。
在线教程：许多在线教育平台（如 Codecademy、Udemy 等）提供了 RESTful API 的入门和进阶课程，适合不同水平的学习者。
社区资源：GitHub、Stack Overflow 等社区中有大量的 RESTful API 相关项目和问题讨论，可以帮助开发者解决实际问题并获取灵感。

希望这篇详细的介绍能帮助您更好地理解和使用 RESTful API，开启您的 Web 开发之旅。

原文地址：https://blog.csdn.net/Zhao_0912/article/details/143942695

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

上一篇：入门车载以太网(6) -- XCP on Ethernet
下一篇：qt学习：linux监听键盘alt+b和鼠标移动事件

Windows电脑本地部署llamafile并接入Qwen大语言模型远程AI对话实战
Windows电脑本地部署llamafile并接入Qwen大语言模型远程AI对话实战
阅读更多2024-11-23
解决vm虚拟机中ctrl键粘滞问题（一直处于按下状态）
虚拟机中点击鼠标左键没有问题，单独按下键盘也没有问题，但是如果按下键盘的同时在按下鼠标左键就会卡住。而且100%稳定复现。发现问题原因：vm版本的问题，我的版本是17.5.0，升级成17.5.2 bu
阅读更多2024-11-23
第十章 JavaScript的应用
10.1.1 JavaScript简介1 简单性JavaScript 设计之初就考虑到了非专业程序员的使用，因此它的语法相对简单，容易上手。2 动态性JavaScript 是一种解释型语言，代码可以在
阅读更多2024-11-23
非root用户安装CUDA
4.下载完成后执行.run文件，需要添加两个参数，一个是--override，用于跳过某些检查或限制；另一个是--toolkitpath，它表示安装路径，必须是自己目录下面的路径，如果是根目录就会安装
阅读更多2024-11-23
Python操作neo4j库py2neo使用之py2neo 删除及事务相关操作（三）
【代码】## Python操作neo4j库py2neo使用之py2neo 删除及事务相关操作（三）
阅读更多2024-11-23
【通俗理解】Jensen不等式与变分分布q(z)在积分计算中的应用
Jensen不等式 #变分分布 #积分计算 #期望 #凸函数 #优化问题 #下界估计 #机器学习。
阅读更多2024-11-23
「Mac玩转仓颉内测版27」基础篇7 - 字符串类型详解
本篇将介绍 Cangjie 中的字符串类型，包括字符串的定义、字面量形式、插值表达、常用操作及应用场景，帮助开发者熟练掌握字符串的使用。
阅读更多2024-11-23
数据科学与SQL：组距分组分析 | 区间分布问题
绝对值分布分析也可以理解为组距分组分析。对于某个指标而言，一个记录对应的指标值的绝对值，肯定落在所有指标值的绝对值的最小值和最大值构成的区间内，根据一定的算法，在把这个区间划分为等距离的几个小区间，，
阅读更多2024-11-23
c++编译报C1004错误的原因及解决办法
可能是你的代码文件最后没有正确的结束符，或者是缺少了一些必要的头文件或语句。默认磁盘驱动器没有足够的空间用于临时文件，需要大约两倍于源文件的空间。编译器到达了源文件尾但未解析构造。计算结果为假的 #i
阅读更多2024-11-23
mysql 去重补全取出重复变量函数和存储过程
mysql 去重补全取出重复变量函数和存储过程
阅读更多2024-11-23