HACKER
TALK
Home
Bookmarks
Messages
Notifications
Sign In
Comment
API 返回数据结构设计怎么做
restful api 返回数据结构大家都是怎么设计的,如何包含错误信息或者额外信息呢?有没最佳实践或者大公司都是怎么做的。
jiayisan
·
3 years ago
Think twice, code once.
有一些标准定义可以参考:
Json API
:不止包含返回数据结构,还有
hateoas
相关信息
odata-json-format
:比较全面的一套 API 通用接口设计
jSend
:简单返回规范
Google json guide
:谷歌的 json 接口规范,和二楼的回答比较相似
HAL
:超文本应用语言,更接近 hateoas 规范,spring boot 的返回数据结构很多就长这样,如下图:
不过讲真的,hateoas 想法很美好,实际很少公司会做到完整的 hateoas 规范,如果真的需要这些表述状态转移信息,不如直接上 graphql 自定义能力更强。
1
Reply
Report
jiayisan
Joined 3 years ago
Think twice, code once.
Follow
Message
Latest posts
app无法登录,抓包数据。网页版可以登录,求分析求解
分享免费云服务器
急切寻求rust编译问题帮助(archlinux, openssl)
分享免费GPT4站点
【轉貼】ASP.NET Core Developer Roadmap in 2024
南京大学研究中心诚募博士后
求助can't establish SSL connection.