接口命名规范

分类:4-全栈/01-elysia

发布于:2026/4/24

阅读时间:10 分钟

三、接口命名规范

1. 方法命名规范（后端逻辑，清晰表达意图）

操作	方法命名	说明
创建	`createXxx`	如 `createProduct`
分页查询	`listXxx`	如 `listProducts`
非分页查询	`allXxx`	如 `allProducts` （可选，推荐优先用 `list` ）
获取单个	`getXxx` / `fetchXxx`	如 `getProduct`
更新	`updateXxx`	如 `updateProduct`
删除	`deleteXxx`	如 `deleteProduct`
批量创建	`batchCreateXxx`	如 `batchCreateProducts`
批量更新	`batchUpdateXxx`	如 `batchUpdateProducts`
批量删除	`batchDeleteXxx`	如 `batchDeleteProducts`

2. URL 路径规范（RESTful，标准、可扩展）

操作	HTTP 方法	URL 路径	说明
创建	`POST`	`/products`	创建商品
分页查询	`GET`	`/products?page=1&size=10`	分页商品列表
非分页查询	`GET`	`/products?filter=xxx`	获取全部或条件查询
获取单个	`GET`	`/products/123`	获取单个商品详情
更新	`PATCH` / `PUT`	`/products/123`	更新商品
删除	`DELETE`	`/products/123`	删除商品
批量操作	`POST` / `PATCH` / `DELETE`	`/products/batch`	批量创建 / 更新 / 删除

✅ 五、一句话总结

推荐你采用 “RESTful URL 设计”（资源用名词、HTTP 方法表达操作） + “语义化后端方法命名”（如
createProduct
、
listProducts
、
batchUpdateProducts
）的组合规范，既符合行业标准，又让代码与接口清晰对应，易于理解、维护和扩展。

🎁 附：你想要的一张完整对照表（方法名 + 操作 + URL + 方法）

你的方法名	操作类型	HTTP 方法	URL 路径	是否 RESTful	说明
`createProduct`	创建	`POST`	`/products`	✅	创建商品
`listProducts`	分页查询	`GET`	`/products?page=1&size=10`	✅	分页商品列表
`allProducts`	非分页查询	`GET`	`/products?filter=xxx`	⚠️ 可选	获取全部商品（建议优先用 list）
`getProduct`	获取单个	`GET`	`/products/123`	✅	获取商品详情
`updateProduct`	更新	`PATCH` / `PUT`	`/products/123`	✅	更新商品
`deleteProduct`	删除	`DELETE`	`/products/123`	✅	删除商品
`batchCreateProducts`	批量创建	`POST`	`/products/batch`	✅	批量创建商品
`batchUpdateProducts`	批量更新	`PATCH`	`/products/batch`	✅	批量更新商品
`batchDeleteProducts`	批量删除	`DELETE`	`/products/batch`	✅	批量删除商品