RestFul的认识

前言

在这里插入图片描述

RESTful 是 Representational State Transfer 的缩写，是一种软件架构风格，用于在网络上构建和整合应用程序。它基于 HTTP 协议，并定义了一组约束和规范，用于规范客户端和服务器之间的通信。

RESTful API 是遵循 REST 架构规范的 API，它允许客户端以标准化的方式与服务器进行交互。RESTful API 通常用于构建 Web 服务，并已被广泛应用于各种领域，包括电子商务、社交媒体、物联网等。

Rest API设计风格原则

1.使用名词而不是动词

  • 不要使用：
    如:
    /getAllUsers get /users get /users/002
    /createNewUser post /users
    /deleteAllUser delete /users/001

2.Get方法和查询参数不应该涉及状态改变

  • 使用PUT, POST 和DELETE 方法 而不是 GET 方法来改变状态，不要使用GET 进行状态改变。

3.使用复数名词

  • 不要混淆名词单数和复数，为了保持简单，只对所有资源使用复数。
    如:
    /cars 而不是 /car
    /users 而不是 /user
    /products 而不是 /product
    /settings 而不是 /setting
    /orders 而不是 /order

4. 使用子资源表达关系

  • 如果一个资源与另外一个资源有关系，使用子资源：
    如:
    GET /cars/711/drivers/ 返回 car 711的所有司机
    GET /cars/711/drivers/4 返回 car 711的4号司机
    GET /users/11/pets 返回 user 11的所有宠物
    GET /users/11/pets/2 返回 user 11的2号宠物

5.使用Http头声明序列化格式

  • 在客户端和服务端，双方都要知道通讯的格式，格式在HTTP-Header中指定
    如:
    Content-Type 定义请求格式
    Accept 定义系列可接受的响应格式

6.为集合提供过滤 排序 选择和分页等功能

  • Filtering过滤:使用唯一的查询参数进行
    GET /cars?color=red 返回红色的cars
    GET /cars?seats<=2 返回小于两座位的cars集合

  • Sorting排序:允许针对多个字段排序
    GET /cars?sort=-manufactorer,+model
    这是返回根据生产者降序和模型升序排列的car集合

  • Field selection
    移动端能够显示其中一些字段，它们其实不需要一个资源的所有字段，给API消费者一个选择字段的能力，这会降低网络流量，提高API可用性。
    GET /cars?fields=manufacturer,model,id,color

  • Paging分页
    使用 limit 和offset.实现分页，缺省limit=20 和offset=0；
    GET /cars?offset=10&limit=5
    为了将总数发给客户端，使用订制的HTTP头： X-Total-Count.
    链接到下一页或上一页可以在HTTP头的link规定，遵循Link规定:
    Link: https://blog.mwaysolutions.com/sample/api/v1/cars?offset=15&limit=5; rel=“next”,https://blog.mwaysolutions.com/sample/api/v1/cars?offset=50&limit=3; rel=“last”,https://blog.mwaysolutions.com/sample/api/v1/cars?offset=0&limit=5; rel=“first”,https://blog.mwaysolutions.com/sample/api/v1/cars?offset=5&limit=5; rel=“prev”,

7.版本化你的API 支付宝 v1 v2 v3

  • 使得API版本变得强制性，不要发布无版本的API，使用简单数字，避免小数点如2.5.
    一般在Url后面使用?v
    /blog/api/v1

8. 使用Http状态码处理错误

  • 如果你的API没有错误处理是很难的，只是返回500和出错堆栈不一定有用
  • Http状态码提供70个出错，我们只要使用10个左右：
    200 – OK – 一切正常
    201 – OK – 新的资源已经成功创建
    204 – OK – 资源已经成功删除
    304 – Not Modified – 客户端使用缓存数据
    400 – Bad Request – 请求无效，需要附加细节解释如 “JSON无效”
    401 – Unauthorized – 请求需要用户验证
    403 – Forbidden – 服务器已经理解了请求，但是拒绝服务或这种请求的访问是不允许的。
    404 – Not found – 没有发现该资源
    422 – Unprocessable Entity – 只有服务器不能处理实体时使用，比如图像不能被格式化，或者重要字段丢失。
    500 – Internal Server Error – API开发者应该避免这种错误。
    使用详细的错误包装错误： 状态码 数据 header头信息
    {
    “errors”: [
    {
    “userMessage”: “Sorry, the requested resource does not exist”,
    “internalMessage”: “No car found in the database”,
    “code”: 34,
    “more info”: “http://dev.mwaysolutions.com/blog/api/v1/errors/12345”
    }
    ]
    }

Rest API案例

没有使用RestFul的规范之前的设计

@Controller
@RequestMapping("user")
public class DemoController {private static final Logger log = LoggerFactory.getLogger(DemoController.class);//查询一个@RequestMapping("findUserById")public String findUserById(Integer id){log.info("查询用户id为:{}",id);//存储到作用域return "showOne";}//查询所有@RequestMapping("findAll")public String findAll(){log.info("查询所有");List<User>  userList =new ArrayList<User>();userList.add(new User(21,"xiaochen",2300,new Date()));//存储到作用域return "showAll";}//保存@RequestMapping("saveUser")public String save(User user){log.info("user: {}",user);return "redirect:/user/findAll";}//修改@RequestMapping("updateUser")public String update(User user){log.info("user: {}",user);return "redirect:/user/findAll";}@RequestMapping("deleteUser")public String delete(User user){log.info("user: {}",user);return "redirect:/user/findAll";}}

这里我们就完全没有按照我们前面所说的RestFul的架构去规范我们的API，下面我们将采用RestFul的设计去规范。

使用了RestFul的设计

@RestController
@RequestMapping("/v1/users") //符合使用复数名词
public class UserController {private static final Logger log = LoggerFactory.getLogger(UserController.class);// ResponeEntity: springmvc 封装一个专用于restful 响应类   这个类在响应时可以提供响应的状态码,同时还可以自定义响应头信息// HttpStatus:   springmvc 封住一个枚举类型类 这个类中都是网络中状态码/*** 查询某个用户详细* @param id* @return*///@RequestMapping(value = "/{id}",method = RequestMethod.GET)@GetMapping("/{id}")  //@RequestMapping:子类注解 使用GETMapping代表只能使用GET方式访问到当前请求//注解: PathVariable:代表在路径中获取请求参数//@ResponseBody //将控制器方法返回值转为jsonpublic ResponseEntity<User> user(@PathVariable("id") Integer id){log.info("本次id: {}",id);User user = null;try {user = new User(id, "小陈", 2300.23, new Date());} catch (Exception e) {e.printStackTrace();return new ResponseEntity<User>(user,HttpStatus.INTERNAL_SERVER_ERROR);}return new ResponseEntity<>(user,HttpStatus.OK);}/*** 用户列表* @return*/@GetMapping//@ResponseBodypublic ResponseEntity<List<User>> users(){ArrayList<User> users = new ArrayList<>();users.add(new User(21,"小王",2300.23,new Date()));users.add(new User(24,"小金豆",3400.23,new Date()));return  new ResponseEntity<>(users,HttpStatus.OK);}/*** 添加用户*/@PostMapping//@ResponseBody  //@ResponseBody 将方法返回值转为json格式数据 并响应请求   @RequestBody: 接收请求json格式数据 将json格式数据转为对象public ResponseEntity<Void> save(@RequestBody  User user){log.info("name:{} salary:{} bir:{}",user.getName(),user.getSalary(),user.getBir());//调用业务方法return new ResponseEntity<>(HttpStatus.NO_CONTENT);//没有内容}/*** 更新用户* @param user*/@PutMapping("/{id}")//@ResponseBodypublic ResponseEntity<Void> update(@PathVariable("id") Integer id,@RequestBody  User user){log.info("id:{} ",id);log.info("name:{} salary:{} bir:{}",user.getName(),user.getSalary(),user.getBir());//调用业务方法return new ResponseEntity<>(HttpStatus.NO_CONTENT);//没有内容}/*** 删除用户信息* @param id*/@DeleteMapping("/{id}")//@ResponseBodypublic ResponseEntity<Void> delete(@PathVariable("id") Integer id){log.info("本次id: {}",id);return new ResponseEntity<>(HttpStatus.NO_CONTENT);//没有内容}/*** 获取这个人所有宠物*/@GetMapping("/{id}/pets")public ResponseEntity<List<Pet>> pets(@PathVariable("id") Integer id){log.info("查询那个人id: {}",id);List<Pet> pets = Arrays.asList(new Pet(21, "小红帽", 23), new Pet(22, "小猪", 22));return new ResponseEntity<>(pets, HttpStatus.OK);}/*** 获取这个人某个宠物*/@GetMapping("/{id}/pets/{pid}")public ResponseEntity<Pet> pet(@PathVariable("id") Integer id,@PathVariable("pid") Integer petId){log.info("查询那个人id: {}",id);Pet pet = new Pet(21, "小红帽", 23);return new ResponseEntity<>(pet, HttpStatus.OK);}}

上述方法就

代码示例的设计特点总结

  1. 使用了 @RestController 注解
    @RestController 注解表示该类是一个 RESTful 控制器，它可以将方法返回值自动转换为 JSON 格式数据并响应请求。

  2. 使用了标准的 HTTP 方法
    @GetMapping：用于处理 GET 请求
    @PostMapping：用于处理 POST 请求
    @PutMapping：用于处理 PUT 请求
    @DeleteMapping：用于处理 DELETE 请求

  3. 使用了 @PathVariable 注解
    @PathVariable 注解用于获取路径中的参数。

  4. 使用了 @RequestBody 注解
    @RequestBody 注解用于接收请求中的 JSON 格式数据并将其转换为对象。

  5. 使用了 ResponseEntity 类
    ResponseEntity 类用于封装响应数据，包括响应状态码和响应体。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/467187.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

Tied Block Convolution: 具有共享较薄滤波器的更简洁、更出色的CNN

Tied Block Convolution: 具有共享较薄滤波器的更简洁、更出色的CNN

摘要 https://arxiv.org/pdf/2009.12021.pdf 卷积是卷积神经网络&#xff08;CNN&#xff09;的主要构建块。我们观察到&#xff0c;随着通道数的增加&#xff0c;优化后的CNN通常具有高度相关的滤波器&#xff0c;这降低了特征表示的表达力。我们提出了Tied Block Convolutio…
阅读更多...
InternLM大模型实战-6.OpenCompass大模型评测

InternLM大模型实战-6.OpenCompass大模型评测

文章目录 前言笔记正文关于模型评测的三个问题为什么需要评测我们需要测什么怎么测试大语言模型 主流大模型评测框架OpenCompass大模型评测领域的挑战 前言 本文是对于InternLM全链路开源体系系列课程的学习笔记。【OpenCompass 大模型评测】 https://www.bilibili.com/video/…
阅读更多...
软件测试 - 测试用例设计方法之等价类划分和边界值分析

软件测试 - 测试用例设计方法之等价类划分和边界值分析

1. 等价类划分法 1.1 基本理论 等价类划分法是通过科学的方法找到具有共同特性的测试输入的集合&#xff0c;避免进行穷举测试&#xff0c;大大减少了测试用例的数量&#xff0c;从而提高测试效率。等价类划分法的典型应用场景就是输入框&#xff0c;适用于较少数量输入框的场…
阅读更多...
LeetCode 0987.二叉树的垂序遍历：遍历时存节点信息，遍历完自定义排序

LeetCode 0987.二叉树的垂序遍历：遍历时存节点信息，遍历完自定义排序

【LetMeFly】987.二叉树的垂序遍历&#xff1a;遍历时存节点信息&#xff0c;遍历完自定义排序 力扣题目链接&#xff1a;https://leetcode.cn/problems/vertical-order-traversal-of-a-binary-tree/ 给你二叉树的根结点 root &#xff0c;请你设计算法计算二叉树的 垂序遍历…
阅读更多...
《Linux 简易速速上手小册》第7章: 网络配置与管理（2024 最新版）

《Linux 简易速速上手小册》第7章: 网络配置与管理（2024 最新版）

文章目录 7.1 Linux 网络基础7.1.1 重点基础知识7.1.2 重点案例&#xff1a;配置静态 IP 地址7.1.3 拓展案例 1&#xff1a;使用 nmcli 配置网络&#xff08;适用于 Fedora/CentOS&#xff09;7.1.4 拓展案例 2&#xff1a;配置无线网络连接 7.2 静态与动态 IP 配置7.2.1 重点基…
阅读更多...
Java学习18-- Override方法重写【★】

Java学习18-- Override方法重写【★】

重点&#xff1a;super类 & 方法重写 ★看不明白多看几遍&#xff0c;记住static优先级>>高于override 重写Override methods★ 重写Override&#xff1a;child class可以覆盖father class中的method&#xff0c;即子类child class和父类father class有相同名称、…
阅读更多...
【Java程序设计】【C00252】基于Springboot的实习管理系统（有论文）

【Java程序设计】【C00252】基于Springboot的实习管理系统（有论文）

基于Springboot的实习管理系统&#xff08;有论文&#xff09; 项目简介项目获取开发环境项目技术运行截图 项目简介 这是一个基于Springboot的实习管理系统 本系统分为前台功能模块、管理员功能模块、教师功能模块、学生功能模块以及实习单位功能模块。 前台功能模块&#xf…
阅读更多...
洛谷: [CSP-J 2023] 小苹果

洛谷: [CSP-J 2023] 小苹果

题目描述 小 Y 的桌子上放着 n n n 个苹果从左到右排成一列&#xff0c;编号为从 1 1 1 到 n n n。 小苞是小 Y 的好朋友&#xff0c;每天她都会从中拿走一些苹果。 每天在拿的时候&#xff0c;小苞都是从左侧第 1 1 1 个苹果开始、每隔 2 2 2 个苹果拿走 1 1 1 个苹果…
阅读更多...
MIT-Missing Semester_Topic 3：Editors (Vim) 练习题

MIT-Missing Semester_Topic 3：Editors (Vim) 练习题

文章目录 练习一练习二练习三练习四练习五练习六练习七练习八 本 Topic 的 MIT 讲解网页&#xff08;练习题未给解答&#xff09; 练习一 自行完成 vimtutor。vimtutor 是 Vim 本身附带的一个入门教程&#xff0c;在 shell 中直接输入 vimtutor 便能运行。注意该教程在 8024 大…
阅读更多...
剑指offer——旋转数组的最小数字

剑指offer——旋转数组的最小数字

目录 1. 题目描述2. 分析思路2.1 示例分析 3. 更完美的做法 1. 题目描述 把一个数组最开始的若干个元素搬到数组的末尾&#xff0c;我们称之为数组的旋转。输入一个递增排序的数组的一个旋转&#xff0c;输出旋转数组的最小元素。例如数组{3.4,5,1.2}为{1.2,3,4,5}的一个旋转&a…
阅读更多...
idea中vue文件如何快捷打出html标签结构，不写＜

idea中vue文件如何快捷打出html标签结构，不写＜

例如写一个<button></button>标签&#xff1a;快捷键如下 先写一个button&#xff0c;然后再按tab键即可自动生成一对标签。 演示&#xff1a; 步骤一&#xff1a; 步骤二&#xff1a;
阅读更多...
Linux进程创建，进程终止，进程等待，进程程序替换，简易shell代码

Linux进程创建，进程终止，进程等待，进程程序替换，简易shell代码

进程创建 fork函数初识 fork函数&#xff1a;从已存在进程中创建一个新进程。新进程为子进程&#xff0c;而原进程为父进程 #include <unistd.h> pid_t fork(void); 返回值&#xff1a;子进程中返回0&#xff0c;父进程返回子进程id&#xff0c;出错返回-1 进程调用 f…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023