讲师中心 微信公众号
AI工具推荐 视频效率加速

REST API 设计中 GET 方法的 HTTP 状态码最佳实践

风萱吖_9918

风萱吖_9918

发布时间:2026-10-16 11:51:02

|

804人浏览过

|

来源于php中文网

原创

REST API 设计中 GET 方法的 HTTP 状态码最佳实践

本文详解 RESTful API 中 GET 请求(如 /cities)应返回的 HTTP 状态码:200 表示成功(含空列表),404 仅用于资源路径不存在,500 用于不可恢复的内部错误(如 JSON 序列化失败)。

本文详解 restful api 中 get 请求(如 `/cities`)应返回的 http 状态码:200 表示成功(含空列表),404 仅用于资源路径不存在,500 用于不可恢复的内部错误(如 json 序列化失败)。

在设计符合 REST 原则的 API 时,HTTP 状态码不仅是技术响应,更是语义契约——它向客户端明确传达“发生了什么”,而非“怎么发生的”。以 GET /cities 为例,其核心语义是“获取城市集合资源”,而非“获取至少一个城市”。因此,状态码的选择必须严格匹配资源状态与操作语义。

✅ 正确使用 200 OK
无论 cities 切片是否为空,只要请求路径有效、业务逻辑正常执行、数据可安全序列化,均应返回 200 OK。空数组 [] 是合法、完整、自描述的数据结构,客户端可通过检查 length 或 data 字段自行处理空结果。例如:

func FindCitiesHandler(w http.ResponseWriter, r *http.Request) {
    w.Header().Set("Content-Type", "application/json;charset=UTF-8")

    // 空列表是有效响应,非错误
    if len(cities) == 0 {
        json.NewEncoder(w).Encode([]City{}) // 显式返回空数组
        return
    }

    if err := json.NewEncoder(w).Encode(cities); err != nil {
        // 此处 err 属于底层编码失败(如写入中断、内存不足),非业务错误
        http.Error(w, "Internal Server Error", http.StatusInternalServerError)
        return
    }
}

❌ 避免误用 404 Not Found
404 仅表示 请求的资源路径不存在(如 /citys 拼写错误,或 /cities/999 查单个不存在城市 ID)。而 /cities 作为集合端点,其存在性由路由定义决定;只要路由注册成功,该资源就“存在”——即使当前无数据。将空列表视为“资源未找到”,会误导客户端重试或报错,违背 REST 的幂等性与可缓存性原则。

Wordpress REST API
Wordpress REST API

OpenClaw技能,提供WordPress REST API命令行工具,支持通过原生HTTP处理文章、页面、分类、标签、用户及自定义请求。

下载

⚠️ 500 Internal Server Error 用于不可控故障
当 json.Encoder 返回非 nil 错误(如 http.ErrBodyWriteAfterHeaders、io.ErrClosedPipe 或底层 write 系统调用失败),表明响应流已损坏或服务异常,此时必须立即终止流程并返回 500。注意:不应在 500 响应体中暴露敏感错误详情(如堆栈跟踪),生产环境建议统一返回简洁错误信息,并记录完整日志供排查:

if err := json.NewEncoder(w).Encode(cities); err != nil {
    log.Printf("JSON encoding failed for /cities: %v", err) // 记录详细错误
    http.Error(w, `{"error":"Failed to process request"}`, http.StatusInternalServerError)
    return
}

补充建议:

  • 对数据库连接失败等数据层异常,应在数据访问层提前捕获,返回 503 Service Unavailable(表示临时不可用,鼓励客户端重试);
  • 若需区分“无数据”与“查询条件不匹配”,可在响应体中增加元字段(如 "count": 0),而非滥用状态码;
  • 所有错误响应建议采用统一 JSON 格式(如 { "error": "...", "code": "INTERNAL_ERROR" }),便于客户端解析。

遵循这些规范,你的 API 将更健壮、可预测,也更容易被前端、网关及自动化工具正确消费。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

相关专题

更多
http500解决方法
http500解决方法

http500解决方法有检查服务器日志、检查代码错误、检查服务器配置、检查文件和目录权限、检查资源不足、更新软件版本、重启服务器或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

3403

2023.11.09

http请求415错误怎么解决
http请求415错误怎么解决

解决方法:1、检查请求头中的Content-Type;2、检查请求体中的数据格式;3、使用适当的编码格式;4、使用适当的请求方法;5、检查服务器端的支持情况。更多http请求415错误怎么解决的相关内容,可以阅读下面的文章。

874

2023.11.14

HTTP 503错误解决方法
HTTP 503错误解决方法

HTTP 503错误表示服务器暂时无法处理请求。想了解更多http错误代码的相关内容,可以阅读本专题下面的文章。

6446

2024.03.12

http与https有哪些区别
http与https有哪些区别

http与https的区别:1、协议安全性;2、连接方式;3、证书管理;4、连接状态;5、端口号;6、资源消耗;7、兼容性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

5410

2024.08.16

Go 语言 HTTP 编程与中间件开发教程合集
Go 语言 HTTP 编程与中间件开发教程合集

全面讲解 Go 语言 HTTP 编程的核心知识,涵盖 net/http 标准库的 Server/Handler/HandlerFunc 体系、DefaultServeMux 路由注册与自定义路由器、Request / ResponseWriter 请求响应处理、中间件(Middleware)链式设计模式与常见中间件(日志/CORS/认证/限流)开发、http.Client 的超时配置与连接池管理、Cookie / Session 处理、

481

2026.05.08

Revel框架入门与安装配置
Revel框架入门与安装配置

本专题从Revel框架环境搭建讲起,系统介绍命令行工具安装、项目创建、目录结构、配置文件及热代码重载,帮助开发者快速完成首个Go Web应用。

0

2026.10.16

Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

0

2026.10.15

MySQL 忘记密码怎么办
MySQL 忘记密码怎么办

MySQL忘记密码专题汇集不同版本与系统下的root密码重置方法,覆盖MySQL 5.7、8.0、Mac、Linux及本地集成环境,并提示恢复权限与重新登录的检查步骤。

0

2026.10.15

Vue.js 中 ref 和 reactive 的区别
Vue.js 中 ref 和 reactive 的区别

Vue.js中ref和reactive的区别专题汇集两种响应式API的定义、访问方式、对象解构、侦听与性能取舍等文章,帮助结合实际状态类型选择合适写法。

0

2026.10.15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
JavaScript OOP调试技巧视频教程
JavaScript OOP调试技巧视频教程

共5课时 | 1.1万人学习

http状态码大全
http状态码大全

共47课时 | 118.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn