Nodejs中用于增删查改的JSON接口的URL命名和http method有没有什么通用的规范

发布于 1周前 作者 yuanlaile 来自 nodejs/Nestjs

Nodejs中用于增删查改的JSON接口的URL命名和http method有没有什么通用的规范

比如
…/create   代表增
…/read     代表查
…/update 代表改
…/delete   代表删

或者
POST     代表增
GET       代表查
PUT       代表改
DELETE 代表删


7 回复

动作不能出现在 URL 里面吧

你需要 restful

这么多年来, RESTful 已经是设计 api 的标配了,现在看来并不是

在Node.js中开发用于增删查改的JSON接口时,URL命名和HTTP方法的通用规范确实存在,并广泛应用于RESTful API设计中。以下是一些通用的命名和方法规范:

URL命名规范

  • 通常会在URL路径中包含api目录或类似虚拟路径以区分普通路径。

  • 使用驼峰命名或下划线命名法,并通常会加上CURD(增删改查)前缀。例如:

    • GET /api/users:获取所有用户
    • POST /api/users:创建一个新用户
    • GET /api/users/:id:根据ID获取单个用户
    • PUT /api/users/:id:更新指定ID的用户
    • DELETE /api/users/:id:删除指定ID的用户

HTTP方法规范

  • GET:用于请求数据。
  • POST:用于提交数据。
  • PUT:用于更新数据(全部字段)。
  • DELETE:用于删除数据。

示例代码

以下是一个使用Express.js框架的简单示例:

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

let users = []; // 存储用户信息的数组

// 示例API接口
app.get('/api/users', (req, res) => { res.json(users); });
app.post('/api/users', (req, res) => { users.push(req.body); res.status(201).json(req.body); });
app.get('/api/users/:id', (req, res) => { /* ...查找并返回用户... */ });
app.put('/api/users/:id', (req, res) => { /* ...更新用户... */ });
app.delete('/api/users/:id', (req, res) => { /* ...删除用户... */ });

app.use(express.json());
app.listen(port, () => { console.log(`Server is running at http://localhost:${port}`); });

遵循这些规范可以提高API的可读性和易用性。

回到顶部