Skip to content

规范文件

Code码以及含义

状态码含义示例功能使用
200OK:请求成功HttpStatus.OK操作成功
201Created:资源已成功创建HttpStatus.CREATED
204No Content:请求成功,但无内容返回HttpStatus.NO_CONTENT
400Bad Request:请求无效,服务器无法理解HttpStatus.BAD_REQUEST
401Unauthorized:未授权HttpStatus.UNAUTHORIZED账号密码不正确
403Forbidden:禁止访问HttpStatus.FORBIDDEN
404Not Found:资源未找到HttpStatus.NOT_FOUND资源未找到
405Method Not Allowed:请求方法不被允许HttpStatus.METHOD_NOT_ALLOWED
409Conflict:请求冲突HttpStatus.CONFLICT
410Gone:资源已永久删除HttpStatus.GONE
422Unprocessable Entity:请求格式正确,但无法处理HttpStatus.UNPROCESSABLE_ENTITY
500Internal Server Error:服务器内部错误HttpStatus.INTERNAL_SERVER_ERROR
502Bad Gateway:无效网关HttpStatus.BAD_GATEWAY
503Service Unavailable:服务不可用HttpStatus.SERVICE_UNAVAILABLE

CRUD接口方法命名规范(NestJS Modules命名规范)

操作接口命名备注非特殊统一命名
查询getXXXXXX为资源名称,例如getUsersgetAll
创建createXXXXXX为资源名称,例如createUsergetOne
更新updateXXXXXX为资源名称,例如updateUserupdateOne
删除deleteXXXXXX为资源名称,例如deleteUserdeleteOne

Released under the MIT License.