{"id":82,"date":"2026-06-16T10:47:32","date_gmt":"2026-06-16T02:47:32","guid":{"rendered":"https:\/\/yykcj.com\/?p=82"},"modified":"2026-06-16T10:47:32","modified_gmt":"2026-06-16T02:47:32","slug":"restful-api-%e8%ae%be%e8%ae%a1%e8%a7%84%e8%8c%83%e4%b8%8e%e6%9c%80%e4%bd%b3%e5%ae%9e%e8%b7%b5%ef%bc%9a%e4%bb%8e%e7%90%86%e8%ae%ba%e5%88%b0%e5%ae%9e%e6%88%98","status":"publish","type":"post","link":"https:\/\/yykcj.com\/?p=82","title":{"rendered":"RESTful API \u8bbe\u8ba1\u89c4\u8303\u4e0e\u6700\u4f73\u5b9e\u8df5\uff1a\u4ece\u7406\u8bba\u5230\u5b9e\u6218"},"content":{"rendered":"

RESTful API \u8bbe\u8ba1\u89c4\u8303\u4e0e\u6700\u4f73\u5b9e\u8df5\uff1a\u4ece\u7406\u8bba\u5230\u5b9e\u6218<\/h1>\n

\u6458\u8981<\/h2>\n

RESTful API\u5df2\u6210\u4e3a\u73b0\u4ee3Web\u670d\u52a1\u7684\u6807\u51c6\u67b6\u6784\u98ce\u683c\u3002\u672c\u6587\u5c06\u4ece\u8d44\u6e90\u547d\u540d\u3001HTTP\u65b9\u6cd5\u3001\u72b6\u6001\u7801\u3001\u7248\u672c\u63a7\u5236\u3001\u5b89\u5168\u7b49\u65b9\u9762\uff0c\u7ed3\u5408Node.js+Express\u5b9e\u6218\uff0c\u5e26\u4f60\u638c\u63e1RESTful API\u7684\u8bbe\u8ba1\u7cbe\u9ad3\u3002<\/p>\n

1. \u5f15\u8a00<\/h2>\n

\u4f60\u662f\u5426\u9047\u5230\u8fc7\u8fd9\u6837\u7684API\uff1a\/getUser?id=1<\/code>\u3001\/deleteUser?id=2<\/code>\u3001\/createUser<\/code>\uff1f\u8fd9\u79cdRPC\u98ce\u683c\u7684\u63a5\u53e3\u4e0d\u4ec5\u6df7\u4e71\uff0c\u800c\u4e14\u96be\u4ee5\u7ef4\u62a4\u3002RESTful API\u901a\u8fc7\u8d44\u6e90\u5bfc\u5411\u548c\u6807\u51c6HTTP\u65b9\u6cd5\uff0c\u63d0\u4f9b\u4e86\u7edf\u4e00\u3001\u53ef\u9884\u6d4b\u7684\u63a5\u53e3\u8bbe\u8ba1\u3002\u672c\u6587\u4e0d\u4ec5\u4f1a\u5217\u51fa\u89c4\u8303\uff0c\u8fd8\u4f1a\u901a\u8fc7\u4e00\u4e2a\u7b80\u5355\u7684\u4efb\u52a1\u7ba1\u7406\u7cfb\u7edf\uff0c\u624b\u628a\u624b\u6559\u4f60\u5b9e\u73b0RESTful API\u3002<\/p>\n

2. \u6838\u5fc3\u539f\u5219<\/h2>\n

2.1 \u8d44\u6e90\u5bfc\u5411<\/h3>\n

URL\u4ee3\u8868\u8d44\u6e90\uff08\u540d\u8bcd\uff09\uff0c\u800c\u975e\u64cd\u4f5c\uff08\u52a8\u8bcd\uff09\u3002\u4f8b\u5982\uff1a<\/p>\n

    \n
  • \u9519\u8bef\uff1a\/getUser<\/code>\u3001\/createUser<\/code><\/li>\n
  • \u6b63\u786e\uff1a\/users<\/code>\u3001\/users\/123<\/code><\/li>\n<\/ul>\n

    2.2 \u4f7f\u7528\u6807\u51c6HTTP\u65b9\u6cd5<\/h3>\n

    | \u65b9\u6cd5 | \u64cd\u4f5c | \u793a\u4f8b | |——|——|——| | GET | \u83b7\u53d6\u8d44\u6e90 | GET \/users<\/code>\u3001GET \/users\/123<\/code> | | POST | \u521b\u5efa\u8d44\u6e90 | POST \/users<\/code> | | PUT | \u5b8c\u5168\u66ff\u6362\u8d44\u6e90 | PUT \/users\/123<\/code> | | PATCH | \u90e8\u5206\u66f4\u65b0\u8d44\u6e90 | PATCH \/users\/123<\/code> | | DELETE | \u5220\u9664\u8d44\u6e90 | DELETE \/users\/123<\/code> |<\/p>\n

    2.3 \u72b6\u6001\u7801\u8868\u8fbe\u7ed3\u679c<\/h3>\n
      \n
    • 2xx \u6210\u529f\uff1a200 OK, 201 Created, 204 No Content<\/li>\n
    • 3xx \u91cd\u5b9a\u5411\uff1a301 Moved Permanently, 304 Not Modified<\/li>\n
    • 4xx \u5ba2\u6237\u7aef\u9519\u8bef\uff1a400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 409 Conflict, 422 Unprocessable Entity<\/li>\n
    • 5xx \u670d\u52a1\u5668\u9519\u8bef\uff1a500 Internal Server Error, 502 Bad Gateway<\/li>\n<\/ul>\n

      3. \u5b9e\u6218\uff1a\u6784\u5efa\u4efb\u52a1\u7ba1\u7406API<\/h2>\n

      \u6211\u4eec\u5c06\u4f7f\u7528Node.js + Express + \u5185\u5b58\u5b58\u50a8\u6765\u6f14\u793a\u3002<\/p>\n

      3.1 \u9879\u76ee\u521d\u59cb\u5316<\/h3>\n
      \nmkdir task-api && cd task-api\nnpm init -y\nnpm install express\n<\/code><\/pre>\n
      3.2 \u57fa\u7840\u670d\u52a1\u5668<\/h3>\n
      \n\/\/ server.js\nconst express = require('express');\nconst app = express();\napp.use(express.json());\n\nlet tasks = [];\nlet idCounter = 1;\n\napp.listen(3000, () => console.log('API running on port 3000'));\n<\/code><\/pre>\n
      3.3 \u8d44\u6e90\u547d\u540d\u4e0e\u7aef\u70b9\u8bbe\u8ba1<\/h3>\n
      | \u7aef\u70b9 | \u65b9\u6cd5 | \u63cf\u8ff0 | |——|——|——| | \/tasks<\/code> | GET | \u83b7\u53d6\u6240\u6709\u4efb\u52a1 | | \/tasks<\/code> | POST | \u521b\u5efa\u65b0\u4efb\u52a1 | | \/tasks\/:id<\/code> | GET | \u83b7\u53d6\u5355\u4e2a\u4efb\u52a1 | | \/tasks\/:id<\/code> | PUT | \u5b8c\u5168\u66ff\u6362\u4efb\u52a1 | | \/tasks\/:id<\/code> | PATCH | \u90e8\u5206\u66f4\u65b0\u4efb\u52a1 | | \/tasks\/:id<\/code> | DELETE | \u5220\u9664\u4efb\u52a1 |<\/p>\n
      3.4 \u5b9e\u73b0CRUD<\/h3>\n
      \n\/\/ \u83b7\u53d6\u6240\u6709\u4efb\u52a1\napp.get('\/tasks', (req, res) => {\n  res.json(tasks);\n});\n\n\/\/ \u521b\u5efa\u4efb\u52a1\napp.post('\/tasks', (req, res) => {\n  const { title, completed } = req.body;\n  if (!title || typeof title !== 'string') {\n    return res.status(400).json({ error: 'Title is required and must be a string' });\n  }\n  const task = {\n    id: idCounter++,\n    title,\n    completed: completed || false,\n    createdAt: new Date().toISOString()\n  };\n  tasks.push(task);\n  res.status(201).json(task);\n});\n\n\/\/ \u83b7\u53d6\u5355\u4e2a\u4efb\u52a1\napp.get('\/tasks\/:id', (req, res) => {\n  const id = parseInt(req.params.id);\n  const task = tasks.find(t => t.id === id);\n  if (!task) return res.status(404).json({ error: 'Task not found' });\n  res.json(task);\n});\n\n\/\/ \u5b8c\u5168\u66ff\u6362\u4efb\u52a1\napp.put('\/tasks\/:id', (req, res) => {\n  const id = parseInt(req.params.id);\n  const index = tasks.findIndex(t => t.id === id);\n  if (index === -1) return res.status(404).json({ error: 'Task not found' });\n  const { title, completed } = req.body;\n  if (!title || typeof title !== 'string') {\n    return res.status(400).json({ error: 'Title is required' });\n  }\n  tasks[index] = {\n    id,\n    title,\n    completed: !!completed,\n    createdAt: tasks[index].createdAt,\n    updatedAt: new Date().toISOString()\n  };\n  res.json(tasks[index]);\n});\n\n\/\/ \u90e8\u5206\u66f4\u65b0\u4efb\u52a1\napp.patch('\/tasks\/:id', (req, res) => {\n  const id = parseInt(req.params.id);\n  const task = tasks.find(t => t.id === id);\n  if (!task) return res.status(404).json({ error: 'Task not found' });\n  const { title, completed } = req.body;\n  if (title !== undefined) {\n    if (typeof title !== 'string') return res.status(400).json({ error: 'Title must be a string' });\n    task.title = title;\n  }\n  if (completed !== undefined) {\n    if (typeof completed !== 'boolean') return res.status(400).json({ error: 'Completed must be a boolean' });\n    task.completed = completed;\n  }\n  task.updatedAt = new Date().toISOString();\n  res.json(task);\n});\n\n\/\/ \u5220\u9664\u4efb\u52a1\napp.delete('\/tasks\/:id', (req, res) => {\n  const id = parseInt(req.params.id);\n  const index = tasks.findIndex(t => t.id === id);\n  if (index === -1) return res.status(404).json({ error: 'Task not found' });\n  tasks.splice(index, 1);\n  res.status(204).send();\n});\n<\/code><\/pre>\n
      \ud83d\udca1 \u6ce8\u610f<\/strong>\uff1aPUT\u5e94\u66ff\u6362\u6574\u4e2a\u8d44\u6e90\uff0c\u56e0\u6b64\u9700\u8981\u63d0\u4f9b\u6240\u6709\u5fc5\u586b\u5b57\u6bb5\uff1bPATCH\u53ea\u66f4\u65b0\u63d0\u4f9b\u7684\u5b57\u6bb5\u3002<\/p>\n
      3.5 \u6d4b\u8bd5API<\/h3>\n
      \u4f7f\u7528curl\u6d4b\u8bd5\uff1a<\/p>\n
      \n# \u521b\u5efa\u4efb\u52a1\ncurl -X POST http:\/\/localhost:3000\/tasks -H "Content-Type: application\/json" -d '{"title":"\u5b66\u4e60REST"}'\n\n# \u83b7\u53d6\u6240\u6709\u4efb\u52a1\ncurl http:\/\/localhost:3000\/tasks\n\n# \u83b7\u53d6\u5355\u4e2a\u4efb\u52a1\ncurl http:\/\/localhost:3000\/tasks\/1\n\n# \u90e8\u5206\u66f4\u65b0\ncurl -X PATCH http:\/\/localhost:3000\/tasks\/1 -H "Content-Type: application\/json" -d '{"completed":true}'\n\n# \u5220\u9664\u4efb\u52a1\ncurl -X DELETE http:\/\/localhost:3000\/tasks\/1\n<\/code><\/pre>\n
      4. \u9ad8\u7ea7\u5b9e\u8df5<\/h2>\n
      4.1 \u8fc7\u6ee4\u3001\u6392\u5e8f\u4e0e\u5206\u9875<\/h3>\n
      \u4f7f\u7528\u67e5\u8be2\u53c2\u6570\uff1a<\/p>\n
      \n\/\/ GET \/tasks?completed=true&sort=-createdAt&page=1&limit=10\napp.get('\/tasks', (req, res) => {\n  let result = [...tasks];\n  \n  \/\/ \u8fc7\u6ee4\n  if (req.query.completed !== undefined) {\n    const completed = req.query.completed === 'true';\n    result = result.filter(t => t.completed === completed);\n  }\n  \n  \/\/ \u6392\u5e8f\n  if (req.query.sort) {\n    const fields = req.query.sort.split(',');\n    fields.forEach(field => {\n      const order = field.startsWith('-') ? -1 : 1;\n      const key = field.replace(\/^-\/, '');\n      result.sort((a, b) => (a[key] > b[key] ? order : -order));\n    });\n  }\n  \n  \/\/ \u5206\u9875\n  const page = parseInt(req.query.page) || 1;\n  const limit = parseInt(req.query.limit) || 10;\n  const start = (page - 1) * limit;\n  const paginated = result.slice(start, start + limit);\n  \n  res.json({\n    data: paginated,\n    total: result.length,\n    page,\n    limit\n  });\n});\n<\/code><\/pre>\n
      4.2 \u7248\u672c\u63a7\u5236<\/h3>\n
      \u63a8\u8350\u4f7f\u7528URL\u8def\u5f84\u7248\u672c\uff1a<\/p>\n
      \napp.use('\/v1', v1Router);\napp.use('\/v2', v2Router);\n<\/code><\/pre>\n
      \u6216\u8005\u8bf7\u6c42\u5934\u7248\u672c\uff08\u66f4\u4f18\u96c5\u4f46\u4e0d\u6613\u53d1\u73b0\uff09\uff1a<\/p>\n
      \napp.use((req, res, next) => {\n  const version = req.headers['accept-version'];\n  req.apiVersion = version || '1';\n  next();\n});\n<\/code><\/pre>\n
      4.3 \u9519\u8bef\u5904\u7406<\/h3>\n
      \u7edf\u4e00\u9519\u8bef\u54cd\u5e94\u683c\u5f0f\uff1a<\/p>\n
      \n\/\/ \u5168\u5c40\u9519\u8bef\u5904\u7406\u4e2d\u95f4\u4ef6\napp.use((err, req, res, next) => {\n  console.error(err.stack);\n  res.status(500).json({\n    error: 'Internal Server Error',\n    message: process.env.NODE_ENV === 'development' ? err.message : 'Something went wrong'\n  });\n});\n<\/code><\/pre>\n
      4.4 \u8ba4\u8bc1\u4e0e\u6388\u6743<\/h3>\n
      \u4f7f\u7528JWT\u793a\u4f8b\uff1a<\/p>\n
      \nconst jwt = require('jsonwebtoken');\n\n\/\/ \u4e2d\u95f4\u4ef6\u9a8c\u8bc1\nfunction authenticate(req, res, next) {\n  const token = req.headers.authorization?.split(' ')[1];\n  if (!token) return res.status(401).json({ error: 'No token provided' });\n  try {\n    const decoded = jwt.verify(token, process.env.JWT_SECRET);\n    req.user = decoded;\n    next();\n  } catch (err) {\n    res.status(403).json({ error: 'Invalid token' });\n  }\n}\n\napp.get('\/tasks', authenticate, (req, res) => {\n  \/\/ \u53ea\u8fd4\u56de\u5f53\u524d\u7528\u6237\u7684\u4efb\u52a1\n  const userTasks = tasks.filter(t => t.userId === req.user.id);\n  res.json(userTasks);\n});\n<\/code><\/pre>\n
      4.5 \u5e42\u7b49\u6027<\/h3>\n
      PUT\u548cDELETE\u5e94\u8be5\u662f\u5e42\u7b49\u7684\u3002\u4f8b\u5982\uff0c\u591a\u6b21DELETE\u540c\u4e00\u4e2a\u8d44\u6e90\u5e94\u8fd4\u56de\u76f8\u540c\u7ed3\u679c\uff08404\uff09\u3002<\/p>\n
      5. \u5e38\u89c1\u9677\u9631<\/h2>\n