在设计API时,对于端点的命名应该遵循一定的约定,以提高代码的可读性和一致性。以下是一些常见的命名约定:
1.使用动词作为HTTP方法,描述请求的目的:
GET /users:获取用户列表 POST /users:创建新用户 PUT /users/123:更新用户ID为123的用户信息 DELETE /users/123:删除用户ID为123的用户
2.使用名词描述资源:
/users:用户 /products:产品 /orders:订单
3.对于嵌套资源,使用“父资源/子资源”的格式:
/users/123/orders:用户ID为123的订单列表
4.对于复数名词,使用复数形式:
GET /users GET /users/123/orders
5.将查询参数拼接在URL末尾:
GET /users?gender=male&age=18
6.使用连字符代替下划线和驼峰式命名法:
GET /user-orders:正确 GET /userOrders:错误 GET /user_orders:错误
示例: //获取用户列表 app.get('/users', function(req, res) { //... });
//创建新用户 app.post('/users', function(req, res) { //... });
//获取用户ID为123的用户信息 app.get('/users/123', function(req, res) { //... });
//更新用户ID为123的用户信息 app.put('/users/123', function(req, res) { //... });
//删除用户ID为123的用户 app.delete('/users/123', function(req, res) { //... });
//获取用户ID为123的订单列表 app.get('/users/123/orders', function(req, res) { //... });
//获取性别为男性,年龄为18岁的用户列表 app.get('/users?gender=male&age=18', function(req, res) { //... });
上一篇:API端点的命名规范