Restful API
目前比较成熟的一套互联网应用程序的API设计理论
一、协议
API与用户的通信协议,总是使用HTTPs协议。
二、域名
应该尽量将API部署在专用域名之下。
https://api.xxxxxx.cn/ |
https://xxxxxx.cn/api/ |
三、版本(Versioning)
应该将API的版本号放入URL。
https://xxxxxx.cn/api/v1/ |
另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。
四、路径(Endpoint)
在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的”集合”(collection),所以API中的名词也应该使用复数。
https://xxxxxx.cn/api/v1/users |
URL中大小写不敏感,不要出现大写字母
_ 和 - 作为API URL连接单词都可以,但是驼峰命名法就算了
五、HTTP动词
对于资源的具体操作类型,由HTTP动词表示。
常用的HTTP动词有下面五个(括号里是对应的SQL命令)。
HTTP动词 | 描述 |
---|---|
GET(SELECT) | 从服务器取出资源(一项或多项)。 |
POST(CREATE) | 在服务器新建一个资源。 |
PUT(UPDATE) | 在服务器更新资源(客户端提供改变后的完整资源)。 |
PATCH(UPDATE) | 在服务器更新资源(客户端提供改变的属性)。 |
DELETE(DELETE) | 从服务器删除资源。 |
GET /users: 列出所有的用户 |
六、过滤信息(Filtering)
如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。
?limit=10:指定返回记录的数量 |
七、状态码(Status Codes)
服务器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)。
200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。 |
八、错误处理(Error handling)
如果状态码是4xx,就应该向用户返回出错信息。一般来说,返回的信息中将error作为键名,出错信息作为键值即可。
{ |
Spring Boot项目中通常需要全局捕获异常,统一处理。
Spring全局异常处理并不能处理Filter中的异常。
九、返回结果
针对不同操作,服务器向用户返回的结果应该符合以下规范。
GET /collection:返回资源对象的列表(数组) |
可以自定义返回结果包装类、返回结果状态码和提示信息等。
{ |
十、接口安全问题
API的身份认证应该使用OAuth 2.0框架。
赏
使用支付宝打赏
使用微信打赏
若你觉得我的文章对你有帮助,欢迎点击上方按钮对我打赏
扫描二维码,分享此文章