SpringBoot进行接口设计

接口可以方便前后端分离，也可以方便他人调用。所以项目进行接口设计是有必要的。这里使用SpringBoot基于REST风格快速进行接口设计。

有关源码和资料可在：https://download.csdn.net/download/qq_36135928/10309244点击打开链接可以进行下载。

下面贴出有关核心代码：

API端:设计接口

@RequestMapping(value = "/api")
@Controller
public class ApiController extends BaseController{@RequestMapping(value = "/getJson.do",method = RequestMethod.POST)@ResponseBodypublic String getJson(){//获取请求中的数据PageData pageData = super.getPageData();//封装返回结果PageData result = new PageData();//签名验证if(!DigestUtil.toSign(pageData).equals(pageData.getString("sign"))){result.put("errCode",100);result.put("errMsg","签名验证失败");return JsonUtil.getJson(result);}//获取请求中的参数//比如传递的参数是 1 就返回一个list数据，否则返回一个stringint parameter = pageData.getInt("parameter");//根据获得的参数，写处理逻辑，可以与数据库交互，这里模拟一个list返回if(parameter == 1){//模拟数据，可与dao层连接List<String> list = new ArrayList<>();list.add("clare");list.add("tung");//参数匹配返回结果result.put("data",JsonUtil.listToJson(list));result.put("errCode",0);result.put("errMsg","");return JsonUtil.getJson(result);}//其他结果返回result.put("data","Nothing");result.put("errCode",102);result.put("errMsg","请求没有结果");return JsonUtil.getJson(result);}
}

Manager端：调用接口

@Service("managerService")
public class ManagerService {public String getJson(int parameter) {//封装请求信息PageData htp = new PageData();htp.put("version","1");htp.put("r",String.valueOf((int)(Math.random()*100)));htp.put("parameter",String.valueOf(parameter));//签名htp.put("sign", DigestUtil.toSign(htp));//发送请求，获得返回数据String json = HttpClientUtils.doPost("http://localhost:8100/api/getJson.do",htp);//可对数据进行处理Map map = JSON.parseObject(json);//签名验证失败if(map.get("errCode").toString().equals("100")){return map.get("errMsg").toString();}//这里直接返回整个json串，看一下效果return json;}}

接口文档：

调用结果在浏览器显示：

补充：签名算法：（签名认证是一种安全机制）

对待签名字符串采用MD5进行加密，将加密串全部转换为小写字母，取第8位开始的16个字符进行反转，生成最终的签名字符串。

例如生成的MD5串为：4f445e77fa27d9bcce5cefdb0b9613a2

生成的最终签名为：bdfec5eccb9d72af

SpringBoot进行接口设计相关推荐

Springboot项目如何设计接口中敏感字段模糊查询？
目录前言场景分析实现方案环境配置依赖配置代码实现总结前言在<Springboot项目如何设计接口中敏感字段的加密.解密>和<Springboot项目如何设计接口中敏 ...
Java后端返回通用接口设计
我印象中,通用返回接口设计是有两种方式,第一种是自定义返回数据的通用类,另一种是springboot中实现ResponseBodyAdvice接口,实现返回数据格式的统一,如我说的有错,请大佬指出.本 ...
SpringBoot提供接口实现Excel导入数据并存储到数据库中
SpringBoot提供接口实现Excel导入数据并存储到数据库中完整项目文件 1 效果展示 1.1 Excel数据 zxy.xlsx 1.2 导入后数据库中数据 CREATE TABLE `use ...
Django博客系统注册（图形验证码接口设计和定义）
1. 准备captcha包(该包用于生成图形验证码) 1.将生成图片验证码的库复制到新建的libs包中. 2.安装Python处理图片的库这儿可能会变红显示错误: 解决方案:在虚拟环境中安装Pill ...
微服务之API网关接口设计
微服务之API网关接口设计 API网关,顾名思义,就是外部到内部的一道门,其主要功能: 服务路由:将前段应用的调用请求路由定位并负载均衡到具体的后端微服务实例,对于前端应用看起来就是1个应用提供的服务 ...
蓝牙(BLE)应用框架接口设计和应用开发——以TI CC2541为例
本文从功能需求的角度分析一般蓝牙BLE单芯片的应用框架(SDK Framework)的接口设计过程,并以TI CC2541为例说明BLE的应用开发方法. 一.应用框架(Framework) 我们熟知的 ...
CPLD/FPGA的UART接口设计之系统时钟（晶振）和波特率关系
UART(UniversalAsynchronous ReceiverTransmitter,通用异步收发器)是一种广泛使用的异步串行数据通信协议.目前大多数MCU.串口通信IC等芯片或模块均支持UA ...
PHP/TP5 接口设计中异常处理
PHP提供 Exception 类来处理异常 new Exception('错误信息(默认为空)','错误代码(默认0)','异常链中前一个异常') 然后可以通过 e -> getMessage ...
【C 语言】文件操作 ( 配置文件读写 | 业务逻辑 | 接口设计 )
文章目录一.配置文件读写业务逻辑二.接口设计 1.写文件接口 2.读文件接口 3.修改文件接口 4.接口合并一.配置文件读写业务逻辑开发一个系统 , 在命令行中实现如下功能 , 通过命令操 ...

SpringBoot进行接口设计

SpringBoot进行接口设计相关推荐

最新文章

热门文章