JavaScript的RESTful API是用JavaScript(如Node.js+Express)开发的符合REST架构风格的后端接口服务,核心包括资源导向、HTTP方法语义化、无状态通信和统一响应格式。
JavaScript 的 RESTful API 不是 JavaScript 自己的特性,而是指用 JavaScript(常配合 Node.js + Express、Koa 等)开发的、符合 REST 架构风格的后端接口服务。
它不是某种语法或框架,而是一套设计约定,关键点包括:
/api/users、/api/posts/123
GET → 获取资源(查)POST → 创建新资源(增)PUT 或 PATCH → 全量或部分更新资源(改)DELETE → 删除资源(删)code、message、data 字段,便于前端统一处理以管理“图书”资源为例,后端代码结构清晰、可读性强:
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.fi
nd(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 });
});
光写对动词和路径还不够,真实项目中这些点容易踩坑:
:id 默认是字符串,用前转成数字或校验格式(如正则 /^\d+$/),避免查库出错/users/123/orders/456/items/789 看似“很 REST”,但难维护;优先用查询参数,如 /items?order_id=456&user_id=123
/api/v1/books,比用 header 更直观易调试用 JavaScript(如 fetch 或 axios)消费时,注意别只看成功回调:
response.ok 或状态码,不要只依赖 then();网络失败、4xx/5xx 都可能进 then
?q=js&page=2),别把复杂对象塞进 body基本上就这些。RESTful 是一种思维方式,不是教条。先保证资源定义清晰、方法用对、错误可追溯,再逐步优化版本、文档、鉴权和性能。不复杂,但容易忽略细节。