随着写的项目代码越来越多,感觉优雅的接口命名,可以大幅提高前端与后端的对接效率.从而整理一下使用到的规范

一.选择HTTP方法

  • GET: 用于检索资源。
  • POST: 用于创建新资源。
  • PUT: 用于更新资源。
  • DELETE: 用于删除资源。

二.使用具体的名词表示资源

  • 使用名词来表示资源，例如 /users 表示用户资源。

三.使用复数形式的名词

  • 对资源使用复数形式的名词，例如 /users 而不是 /user.

四.使用清晰的URL结构

  • 使用清晰的URL路径，例如 /users/{id} 表示获取特定用户.

五.使用查询参数进行过滤和排序

  • 使用查询参数如 ?sort=field 或 ?filter=value 来进行排序和过滤.

六.使用HTTP状态码来表示操作结果

  • 使用适当的HTTP状态码来表示操作结果，例如 200 OK、201 Created、204 No Content、400 Bad Request、404 Not Found 等.