前后端接口写法(传输数据)

2024-04-08 09:28
文章标签 接口 写法 传输数据

本文主要是介绍前后端接口写法(传输数据),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

目录

  • 前言
  • 1. 零散数据
  • 2. 函数体
  • 3. 总结

前言

对于后端常用的两个注解:详细分析Java中的@RequestParam和@RequestBody

以下文章主要用于笔记总结,后续可翻看

1. 零散数据

前端数据

export const doWeekPlan = (ids,selectedPeriod) => {return request({url: '/api/blade-equipment/inforunningdata/doWeekPlan',method: 'post',params: {ids,selectedPeriod}})
}

此时需要带上@RequestParam ,也可以不要@RequestParam

@PostMapping("/doWeekPlan")
@ApiOperationSupport(order = 10)
@ApiOperation(value = "周计划" , notes = "传入infoRunningDataVO")
public R doWeekPlan(@RequestParam Long ids,@RequestParam String selectedPeriod){Result result = null;try {result = infoRunningDataService.doWeekPlan(ids,selectedPeriod);return R.status(result.getIsTrue());}catch (Exception e){return R.fail(e.getMessage());}
}

带不带@RequestParam 的差异之处在于:

使用了 @RequestParam 注解,需明确指定每个参数的名称,并且参数是作为请求的一部分发送的,特别是Get请求

没有使用 @RequestParam 注解,而是直接将参数作为方法的参数传递。这种写法通常适用于 POST 请求,其中参数是通过请求体发送的。Spring 框架默认会将请求体中的数据与方法参数进行绑定

如果数据是通过请求体发送的,并且想要保持代码更加简洁,可以选择不使用 @RequestParam 注解。但如果明确指定参数名称或者处理 GET 请求,那么第一种写法会更加合适

2. 函数体

以下为get请求:

export const getList = (current, size, params,tenantId) => {return request({url: '/api/blade-equipment/inforunningdata/list',method: 'get',params: {...params,current,size,tenantId}})
}

后端数据

@GetMapping("/list")
@ApiOperationSupport(order = 2)
@ApiOperation(value = "分页", notes = "传入infoRunningData")
public R<IPage<InfoRunningDataVO>> list(InfoRunningData infoRunningData, Query query,String tenantId) {IPage<InfoRunningData> pages = infoRunningDataService.page(Condition.getPage(query),Condition.getQueryWrapper(infoRunningData).eq("tenant_id",tenantId));return R.data(InfoRunningDataWrapper.build().pageVO(pages));
}

如果是post请求:

export const add = (row) => {return request({url: '/api/blade-equipment/weekplan/save',method: 'post',data: row})
}

后端

@PostMapping("/save")
@ApiOperationSupport(order = 4)
@ApiOperation(value = "新增", notes = "传入weekPlan")
public R save(@Valid @RequestBody WeekPlan weekPlan) {boolean save = weekPlanService.save(weekPlan);if(save == false){String errorMessage = "存在如下周计划:\n" +"机种:" + weekPlan.getParentModel() + "\n" +",时间段:" + weekPlan.getPlanTime() + "\n";throw new RuntimeException(errorMessage);}return R.status(save);
}

需要在请求体中发送一个对象时,使用 @RequestBody 注解以及 POST 请求。
需要发送一系列查询参数时,使用 GET 请求,并将参数作为查询参数发送

3. 总结

对于新增操作:(适用于需要创建新资源的场景)
前端通常使用 POST 请求,并将数据作为请求的主体发送到后端
后端使用 @RequestBody 注解来接收请求体中的数据

对于查询操作:(根据特定条件检索数据的场景)
前端通常使用 GET 请求,并将查询参数作为 URL 的一部分发送到后端
后端使用 @RequestParam 或直接作为方法参数来接收查询参数

两种写法都是有效的,但适用于不同的场景,具体选择取决于需求和偏好
在设计接口时,需要考虑到前后端数据的传输方式、请求类型以及参数的处理方式,以便实现更好的交互和数据传递

这篇关于前后端接口写法(传输数据)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/885190

相关文章

usb接口驱动异常问题常用解决方案

《usb接口驱动异常问题常用解决方案》当遇到USB接口驱动异常时,可以通过多种方法来解决,其中主要就包括重装USB控制器、禁用USB选择性暂停设置、更新或安装新的主板驱动等... usb接口驱动异常怎么办,USB接口驱动异常是常见问题,通常由驱动损坏、系统更新冲突、硬件故障或电源管理设置导致。以下是常用解决

go中空接口的具体使用

《go中空接口的具体使用》空接口是一种特殊的接口类型,它不包含任何方法,本文主要介绍了go中空接口的具体使用,具有一定的参考价值,感兴趣的可以了解一下... 目录接口-空接口1. 什么是空接口?2. 如何使用空接口?第一,第二,第三,3. 空接口几个要注意的坑坑1:坑2:坑3:接口-空接口1. 什么是空接

如何用java对接微信小程序下单后的发货接口

《如何用java对接微信小程序下单后的发货接口》:本文主要介绍在微信小程序后台实现发货通知的步骤,包括获取Access_token、使用RestTemplate调用发货接口、处理AccessTok... 目录配置参数 调用代码获取Access_token调用发货的接口类注意点总结配置参数 首先需要获取Ac

讯飞webapi语音识别接口调用示例代码(python)

《讯飞webapi语音识别接口调用示例代码(python)》:本文主要介绍如何使用Python3调用讯飞WebAPI语音识别接口,重点解决了在处理语音识别结果时判断是否为最后一帧的问题,通过运行代... 目录前言一、环境二、引入库三、代码实例四、运行结果五、总结前言基于python3 讯飞webAPI语音

MyBatis-Plus中Service接口的lambdaUpdate用法及实例分析

《MyBatis-Plus中Service接口的lambdaUpdate用法及实例分析》本文将详细讲解MyBatis-Plus中的lambdaUpdate用法,并提供丰富的案例来帮助读者更好地理解和应... 目录深入探索MyBATis-Plus中Service接口的lambdaUpdate用法及示例案例背景

Java8需要知道的4个函数式接口简单教程

《Java8需要知道的4个函数式接口简单教程》:本文主要介绍Java8中引入的函数式接口,包括Consumer、Supplier、Predicate和Function,以及它们的用法和特点,文中... 目录什么是函数是接口?Consumer接口定义核心特点注意事项常见用法1.基本用法2.结合andThen链

Deepseek R1模型本地化部署+API接口调用详细教程(释放AI生产力)

《DeepseekR1模型本地化部署+API接口调用详细教程(释放AI生产力)》本文介绍了本地部署DeepSeekR1模型和通过API调用将其集成到VSCode中的过程,作者详细步骤展示了如何下载和... 目录前言一、deepseek R1模型与chatGPT o1系列模型对比二、本地部署步骤1.安装oll

MyBatis-Flex BaseMapper的接口基本用法小结

《MyBatis-FlexBaseMapper的接口基本用法小结》本文主要介绍了MyBatis-FlexBaseMapper的接口基本用法小结,文中通过示例代码介绍的非常详细,对大家的学习或者工作具... 目录MyBATis-Flex简单介绍特性基础方法INSERT① insert② insertSelec

Spring排序机制之接口与注解的使用方法

《Spring排序机制之接口与注解的使用方法》本文介绍了Spring中多种排序机制,包括Ordered接口、PriorityOrdered接口、@Order注解和@Priority注解,提供了详细示例... 目录一、Spring 排序的需求场景二、Spring 中的排序机制1、Ordered 接口2、Pri

Idea实现接口的方法上无法添加@Override注解的解决方案

《Idea实现接口的方法上无法添加@Override注解的解决方案》文章介绍了在IDEA中实现接口方法时无法添加@Override注解的问题及其解决方法,主要步骤包括更改项目结构中的Languagel... 目录Idea实现接China编程口的方法上无法添加@javascriptOverride注解错误原因解决方