网站开发前景,saas平台是什么意思,中国建设部官网信息查询,设计师网站十大网站排名目前开发的项目很大程度上是为明年的国产化做准备了#xff0c;所以借这个机会把用了十年的自研系统全部重写#xff0c;订立更严格的规范#xff0c;本文记录一下返回格式及对应状态码。 常见 HTTP 状态码及解释
HTTP 状态码用于表示客户端请求的响应状态#xff0c;它们… 目前开发的项目很大程度上是为明年的国产化做准备了所以借这个机会把用了十年的自研系统全部重写订立更严格的规范本文记录一下返回格式及对应状态码。 常见 HTTP 状态码及解释
HTTP 状态码用于表示客户端请求的响应状态它们分为五类2xx 表示成功3xx 表示重定向4xx 表示客户端错误5xx 表示服务器错误。以下是各类状态码的详细解释。
2xx 成功响应
状态码含义解释200OK请求成功服务器返回了请求的数据。GET 请求通常返回数据PUT/POST 请求返回更新或创建的数据。201Created请求成功创建了新资源通常用于 POST 或 PUT 请求。响应头包含新资源的 URL。202Accepted请求已接受但尚未完成处理通常用于异步任务。204No Content请求成功但服务器未返回内容常用于删除操作或不需返回内容的操作。
3xx 重定向
状态码含义解释301Moved Permanently资源的 URL 已永久更改客户端应重定向到新的 URL响应头包含 Location 字段。302Found资源的 URL 暂时更改客户端通常会重定向到响应头中的 Location 字段。304Not Modified资源未更改客户端可以使用缓存版本通常用于浏览器缓存优化。
4xx 客户端错误
状态码含义解释400Bad Request请求有误服务器无法处理通常由于无效的请求参数。错误详情通常在响应体的 errors 字段中返回。401Unauthorized未经授权通常是由于缺少或无效的身份认证如 Token。403Forbidden已认证用户无权访问该资源即使认证通过也无法访问。404Not Found资源未找到通常表示客户端请求的 URL 或资源不存在。405Method Not Allowed请求方法不被允许例如对只支持 GET 的资源使用了 POST。422Unprocessable Entity请求格式正确但语义错误服务器无法处理。例如提交了无效的数据格式。
5xx 服务器错误
状态码含义解释500Internal Server Error服务器内部错误可能是未知问题或代码异常导致无法完成请求。502Bad Gateway作为网关或代理的服务器从上游服务器收到无效响应通常表示服务器之间的通信问题。503Service Unavailable服务器暂时无法处理请求通常用于服务器维护或过载。504Gateway Timeout作为网关或代理的服务器未能在规定时间内从上游服务器获得响应。
状态码使用建议
成功场景
200 OK用于数据获取GET 请求和数据更新PUT 请求的成功响应。201 Created用于新资源创建成功POST 或 PUT 请求中常见。204 No Content用于不返回数据的请求例如删除或不需返回内容的请求。
错误场景
400 Bad Request用于无效参数错误并返回详细的 errors 信息。401 Unauthorized用于身份认证失败。403 Forbidden用于权限不足时的响应。404 Not Found用于资源不存在的情况客户端请求的 URL 错误时常见。422 Unprocessable Entity用于语义错误或数据校验失败并可返回具体错误信息。
系统级别问题
500 Internal Server Error、502 Bad Gateway、503 Service Unavailable用于服务器内部、网关或资源不可用等问题通常表明可以稍后重试请求。
示例响应结构
设计响应结构时可以包含 status、code、message、data 和 errors 等字段以便前端能快速判断响应结果。
成功响应结构示例
{status: success,code: 200,message: 获取用户信息成功,data: {user: {id: 1,username: user123,email: user123example.com,phone: 12345678901,role: admin},token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...},errors: []
}错误响应结构示例
{status: error,code: 400,message: 请求参数错误,data: {},errors: [{field: username,message: 用户名不能为空},{field: password,message: 密码长度必须大于6个字符}]
}错误响应格式带有数据
部分成功的数据 在一些批量操作如文件上传或数据验证中前端可能希望了解哪些请求成功哪些失败以便更好地展示处理状态。默认值提示 当输入缺少时data 可以返回可用的默认值或推荐值。
如果允许在错误情况下返回 data建议在 errors 中提供尽可能详细的说明以便前端清楚如何使用 data 中的内容。可以考虑以下格式
{code: 400,message: 请求参数错误部分数据不可用,data: {user: {username: user123, // 部分有效数据email: user123example.com},defaults: {role: guest // 默认值或推荐值}},errors: [{field: phone,message: 手机号格式不正确},{field: password,message: 密码长度必须大于6个字符}]
}结构设计建议
data 和 errors 可共存允许在错误响应中返回部分有效数据及详细错误信息。message 提供简短描述便于用户理解。code 以 HTTP 状态码的数字形式显示便于客户端判断请求状态。code 和 status 可以考虑合并
这种设计能确保数据结构清晰便于前后端调试与维护。
