JavaScript的RESTful API是用JavaScript(如Node.js+Express)开发的符合REST架构风格的后端接口服务,核心包括资源导向、HTTP方法语义化、无状态通信和统一响应格式。

JavaScript 的 RESTful API 不是 JavaScript 自己的特性,而是指用 JavaScript(常配合 Node.js + Express、Koa 等)开发的、符合 REST 架构风格的后端接口服务。
RESTful API 的核心原则
它不是某种语法或框架,而是一套设计约定,关键点包括:
-
资源导向:把业务对象(如用户、订单、文章)抽象成“资源”,用统一的 URI 表示,例如
/api/users、/api/posts/123 -
HTTP 方法语义化:用标准方法表达操作意图
•GET→ 获取资源(查)
•POST→ 创建新资源(增)
•PUT或PATCH→ 全量或部分更新资源(改)
•DELETE→ 删除资源(删) - 无状态通信:每次请求携带完整上下文(如 token、参数),服务器不保存客户端会话
-
统一响应格式:比如始终返回 JSON,含
code、message、data字段,便于前端统一处理
用 JavaScript 设计一个简单示例(Express)
以管理“图书”资源为例,后端代码结构清晰、可读性强:
const express = require('express');
const app = express();
app.use(express.json());
// 获取所有图书
app.get('/api/books', (req, res) => {
res.json({ code: 0, message: 'success', data: books });
});
// 获取某本图书
app.get('/api/books/:id', (req, res) => {
const book = books.find(b => b.id === +req.params.id);
if (!book) return res.status(404).json({ code: 404, message: 'Not found', data: null });
res.json({ code: 0, message: 'success', data: book });
});
// 新增图书
app.post('/api/books', (req, res) => {
const { title, author } = req.body;
const newBook = { id: books.length + 1, title, author };
books.push(newBook);
res.status(201).json({ code: 0, message: 'Created', data: newBook });
});
// 更新图书
app.put('/api/books/:id', (req, res) => {
const idx = books.findIndex(b => b.id === +req.params.id);
if (idx === -1) return res.status(404).json({ code: 404, message: 'Not found' });
books[idx] = { ...books[idx], ...req.body };
res.json({ code: 0, message: 'Updated', data: books[idx] });
});
// 删除图书
app.delete('/api/books/:id', (req, res) => {
const idx = books.findIndex(b => b.id === +req.params.id);
if (idx === -1) return res.status(404).json({ code: 404, message: 'Not found' });
books.splice(idx, 1);
res.json({ code: 0, message: 'Deleted', data: null });
});
设计时要注意的实用细节
光写对动词和路径还不够,真实项目中这些点容易踩坑:
技术上面应用了三层结构,AJAX框架,URL重写等基础的开发。并用了动软的代码生成器及数据访问类,加进了一些自己用到的小功能,算是整理了一些自己的操作类。系统设计上面说不出用什么模式,大体设计是后台分两级分类,设置好一级之后,再设置二级并选择栏目类型,如内容,列表,上传文件,新窗口等。这样就可以生成无限多个二级分类,也就是网站栏目。对于扩展性来说,如果有新的需求可以直接加一个栏目类型并新加功能操作
立即学习“Java免费学习笔记(深入)”;
-
ID 类型要明确:URI 中的
:id默认是字符串,用前转成数字或校验格式(如正则/^\d+$/),避免查库出错 - 错误要分层处理:参数校验失败(400)、未授权(401)、无权限(403)、找不到(404)、服务异常(500)——不同状态码让前端更好做反馈
-
避免过度嵌套路由:像
/users/123/orders/456/items/789看似“很 REST”,但难维护;优先用查询参数,如/items?order_id=456&user_id=123 -
版本控制建议加在 URL 或 Header 中:初学者可用
/api/v1/books,比用 header 更直观易调试
前端调用时的小提醒
用 JavaScript(如 fetch 或 axios)消费时,注意别只看成功回调:
- 检查
response.ok或状态码,不要只依赖then();网络失败、4xx/5xx 都可能进then - 统一封装请求函数,自动加 token、处理 loading、拦截错误并提示(如 401 跳登录页)
- GET 请求传参优先用 URL 查询参数(
?q=js&page=2),别把复杂对象塞进 body
基本上就这些。RESTful 是一种思维方式,不是教条。先保证资源定义清晰、方法用对、错误可追溯,再逐步优化版本、文档、鉴权和性能。不复杂,但容易忽略细节。










