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

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

相关文章

Codeforces Beta Round #47 C凸包 (最终写法)

题意慢慢看。 typedef long long LL ;int cmp(double x){if(fabs(x) < 1e-8) return 0 ;return x > 0 ? 1 : -1 ;}struct point{double x , y ;point(){}point(double _x , double _y):x(_x) , y(_y){}point op

Java 后端接口入参 - 联合前端VUE 使用AES完成入参出参加密解密

加密效果: 解密后的数据就是正常数据: 后端:使用的是spring-cloud框架,在gateway模块进行操作 <dependency><groupId>com.google.guava</groupId><artifactId>guava</artifactId><version>30.0-jre</version></dependency> 编写一个AES加密

java线程深度解析(一)——java new 接口?匿名内部类给你答案

http://blog.csdn.net/daybreak1209/article/details/51305477 一、内部类 1、内部类初识 一般,一个类里主要包含类的方法和属性,但在Java中还提出在类中继续定义类(内部类)的概念。 内部类的定义:类的内部定义类 先来看一个实例 [html]  view plain copy pu

模拟实现vector中的常见接口

insert void insert(iterator pos, const T& x){if (_finish == _endofstorage){int n = pos - _start;size_t newcapacity = capacity() == 0 ? 2 : capacity() * 2;reserve(newcapacity);pos = _start + n;//防止迭代

京东物流查询|开发者调用API接口实现

快递聚合查询的优势 1、高效整合多种快递信息。2、实时动态更新。3、自动化管理流程。 聚合国内外1500家快递公司的物流信息查询服务,使用API接口查询京东物流的便捷步骤,首先选择专业的数据平台的快递API接口:物流快递查询API接口-单号查询API - 探数数据 以下示例是参考的示例代码: import requestsurl = "http://api.tanshuapi.com/a

股票数据接口-陈科肇

陈科肇 新浪财经 sz-深圳sh-上海历史分价表:http://market.finance.sina.com.cn/pricehis.php?symbol=sz000506&startdate=2016-12-27&enddate=2016-12-27历史成交明细(当日成交明细):http://vip.stock.finance.sina.com.cn/quotes_service/v

实例demo理解面向接口思想

浅显的理解面向接口编程 Android开发的语言是java,至少目前是,所以理解面向接口的思想是有必要的。下面通过一个简单的例子来理解。具体的概括我也不知道怎么说。 例子: 现在我们要开发一个应用,模拟移动存储设备的读写,即计算机与U盘、MP3、移动硬盘等设备进行数据交换。已知要实现U盘、MP3播放器、移动硬盘三种移动存储设备,要求计算机能同这三种设备进行数据交换,并且以后可能会有新的第三方的

对接话费充值API接口的开发步骤以及各种优势

对接话费充值API接口通常涉及以下步骤: 1.选择API提供商: 研究并选择一个可靠的话费充值API提供商。考虑因素包括覆盖范围、费率、交易限额、客户支持和用户评价。 2.注册和获取API密钥: 在选定的API提供商平台上注册账户,并获取API密钥或访问令牌,这是调用API时进行身份验证的必要信息。 3.阅读API文档: 仔细阅读API文档,了解如何构建请求、需要哪些参数、API的

java类中定义接口的有哪些好处

第一步:首先是是定义一个类,同时里面定义接口 public class Util { public interface Worker { void work(int a); } } 第二步:定义一个类去实现第一步类中定义的接口 public class Demo implements Worker { @Override public void work(int a) { System

[苍穹外卖]-04菜品管理接口开发

效果预览 新增菜品 需求分析 查看产品原型分析需求, 包括用到哪些接口, 业务的限制规则 业务规则 菜品名称必须是唯一的菜品必须属于某个分类下, 不能单独存在新增菜品时可以根据情况选择菜品的口味每个菜品必须对应一张图片 接口设计 根据类型查询分类接口 文件上传接口 新增菜品接口 数据表设计 设计dish菜品表 和 dish_fl