API端点的命名约定
创始人
2024-09-07 12:31:43
0

在设计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) { //... });

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...