时代Java,与您同行!
关注微信公众号,关注前沿技术,微信搜索:nowjava或时代Java,也可点击这里扫码关注
时代Java
首页
集册
文章
实例
项目
快讯
时代+
手册
下载
Jar查找
登录
注册
集册
HTTP API 设计指南
HTTP API 设计指南
—— 基本的 HTTP+JSON API 设计方法
欢马劈雪
更新时间:2020-12-28 01:56:03
14881
在这篇文章中:
基本的 HTTP+JSON API 设计方法,所以本篇指南并不包含所有的 API 设计基础。
目录
集册首页
关于
基础
隔离关注点
强制使用安全连接(Secure Connections)
强制头信息 Accept 中提供版本号
支持 Etag 缓存
为内省而提供 Request-Id
通过请求中的范围(Range)拆分大的响应
请求(Requests)
返回合适的状态码
提供全部可用的资源
在请求的 body 体使用 JSON 格式数据
使用统一的资源路径格式
路径和属性要小写
支持方便的无 id 间接引用
最小化路径嵌套
响应(Responses)
提供资源的(UU)ID
提供标准的时间戳
使用 UTC(世界标准时间)时间,用 ISO8601 进行格式化
嵌套外键关系
生成结构化的错误
显示频率限制状态
保证响应 JSON 最小化
工件(Artifacts)
可读性
提供可执行的例子
描述稳定性
良好打印的默认 JSON
热门集册
Java实例教程
Mybatis 实战教程
SQL 语法入门教程
MySQL数据库入门与基础应用教程
Spring Boot 入门实践
返回顶部