专栏名称: 互联网后端架构
主要介绍Java后端架构。其中也会掺杂一些前端、GO、Python、Linux,目标:全栈工程师!---好像很牛叉的样子 ^-^
今天看啥  ›  专栏  ›  互联网后端架构

10个有关RESTful API良好设计的最佳实践

互联网后端架构  · 公众号  · 架构  · 2019-05-16 21:00
    

文章预览

—  扫描二维码  — 加入架构集结群    对技术感兴趣的同学可进群(备注:Java)         Web API已经在最近几年变成重要的话题,一个干净的API设计对于后端系统是非常重要的。   通常我们为Web API使用RESTful设计,REST概念分离了API结构和逻辑资源,通过Http方法GET, DELETE, POST 和 PUT来操作资源。   下面是进行RESTful Web API十个最佳实践,能为你提供一个良好的API设计风格。 1.使用名词而不是动词 Resource 资源 GET 读 POST 创建 PUT 修改 DELETE /cars 返回 cars集合 创建新的资源 批量更新cars 删除所有cars /cars/711 返回特定的car 该方法不允许(405) 更新一个指定的资源 擅长指定资源 不要使用: /getAllCars /createNewCar /deleteAllRedCars   2.Get方法和查询参数不应该涉及状态改变 使用 PUT, ………………………………

原文地址:访问原文地址
快照地址: 访问文章快照
总结与预览地址:访问总结与预览