Appearance
规范文件
Code码以及含义
状态码 | 含义 | 示例 | 功能使用 |
---|---|---|---|
200 | OK:请求成功 | HttpStatus.OK | 操作成功 |
201 | Created:资源已成功创建 | HttpStatus.CREATED | |
204 | No Content:请求成功,但无内容返回 | HttpStatus.NO_CONTENT | |
400 | Bad Request:请求无效,服务器无法理解 | HttpStatus.BAD_REQUEST | |
401 | Unauthorized:未授权 | HttpStatus.UNAUTHORIZED | 账号密码不正确 |
403 | Forbidden:禁止访问 | HttpStatus.FORBIDDEN | |
404 | Not Found:资源未找到 | HttpStatus.NOT_FOUND | 资源未找到 |
405 | Method Not Allowed:请求方法不被允许 | HttpStatus.METHOD_NOT_ALLOWED | |
409 | Conflict:请求冲突 | HttpStatus.CONFLICT | |
410 | Gone:资源已永久删除 | HttpStatus.GONE | |
422 | Unprocessable Entity:请求格式正确,但无法处理 | HttpStatus.UNPROCESSABLE_ENTITY | |
500 | Internal Server Error:服务器内部错误 | HttpStatus.INTERNAL_SERVER_ERROR | |
502 | Bad Gateway:无效网关 | HttpStatus.BAD_GATEWAY | |
503 | Service Unavailable:服务不可用 | HttpStatus.SERVICE_UNAVAILABLE |
CRUD接口方法命名规范(NestJS Modules命名规范)
操作 | 接口命名 | 备注 | 非特殊统一命名 |
---|---|---|---|
查询 | getXXX | XXX 为资源名称,例如getUsers | getAll |
创建 | createXXX | XXX 为资源名称,例如createUser | getOne |
更新 | updateXXX | XXX 为资源名称,例如updateUser | updateOne |
删除 | deleteXXX | XXX 为资源名称,例如deleteUser | deleteOne |