开发指南002-前后端信息交互规范-请求类

简介: 请求类由org.qlm.io.vo.RequestInfo定义:

 请求类由org.qlm.io.vo.RequestInfo定义:


//1.0
@Schema(description = "平台-请求包版本标识 用于版本兼容")
private String version;
@Schema(description = "平台-请求者")
private String consumer;//请求者 标识发出请求的系统
@Schema(description = "平台-请求流水号")
private String serialNo;//请求流水号
@Schema(description = "平台-请求者语言")
private String language;//请求者 要求使用的语言 zh-cn zh-tw en jp
//分页要求参数
@Schema(description = "平台-页码 下标从0开始")
private Integer page;//页码  下标从0开始
@Schema(description = "平台-每页最大数据")
private Integer size;//每页最大数据
//附加参数
@Schema(description = "平台-附加参数 简单的单参数请求可以使用该参数")
private String tag;
@Schema(description = "平台-描述tag的用处")
private String tagDescription;
@Schema(description = "平台-附加参数2 简单的单参数请求可以使用该参数")
private String tag2;
@Schema(description = "平台-描述tag2的用处")
private String tagDescription2;

image.gif

简单的请求(1-2个参数)直接使用 RequestInfo即可,例如删除请求,将要删除对象的id存入tag即可。对于复杂的请求,需要定义一个dto扩展RequestInfo。之所以这样做,而不是在Requestinfo中定义一个模板属性private T data;//具体请求信息 是因为swagger里无法正确解析T。

version:目前为“1.0”,之所以设计这个属性是为了保持兼容。(例如后台可能同时接收到1.0或1.1的请求包)

consumer:标识请求,在前端配置文件中定义

serialNo:uuid,唯一标识一个请求

相关文章
|
6月前
|
监控 应用服务中间件 API
API 网关的功能用途及实现方式
API 网关的功能用途及实现方式
|
3月前
|
安全 API 开发工具
开发api数据接口的工作步骤
本文概述了使用Python的Flask框架开发简单API数据接口的基本步骤。首先,需明确API提供的数据及其来源,确保数据的真实可靠。其次,选择合适的开发工具和技术栈,如Python结合Flask,并安装所需环境。编写代码时,应导入必要模块、创建应用实例、定义数据、设计路由及处理函数,并考虑错误处理和日志记录。测试阶段,在本地启动服务器并使用工具验证功能和性能。最后,选择合适平台部署API,并确保其稳定性和安全性。在整个过程中,需注重数据安全、代码质量及系统性能优化。
|
3月前
|
API C# 开发框架
WPF与Web服务集成大揭秘:手把手教你调用RESTful API,客户端与服务器端优劣对比全解析!
【8月更文挑战第31天】在现代软件开发中,WPF 和 Web 服务各具特色。WPF 以其出色的界面展示能力受到欢迎,而 Web 服务则凭借跨平台和易维护性在互联网应用中占有一席之地。本文探讨了 WPF 如何通过 HttpClient 类调用 RESTful API,并展示了基于 ASP.NET Core 的 Web 服务如何实现同样的功能。通过对比分析,揭示了两者各自的优缺点:WPF 客户端直接处理数据,减轻服务器负担,但需处理网络异常;Web 服务则能利用服务器端功能如缓存和权限验证,但可能增加服务器负载。希望本文能帮助开发者根据具体需求选择合适的技术方案。
157 0
|
3月前
|
开发框架 前端开发 API
使用代码生成工具快速开发应用-结合后端Web API提供接口和前端页面快速生成,实现通用的业务编码规则管理
使用代码生成工具快速开发应用-结合后端Web API提供接口和前端页面快速生成,实现通用的业务编码规则管理
若依修改,修改代理线上接口登录后台,若依框架如何使用线上的接口,如何在本地获取网页上的接口
若依修改,修改代理线上接口登录后台,若依框架如何使用线上的接口,如何在本地获取网页上的接口
|
6月前
|
前端开发 API Docker
web前端开发项目走proxy代理后端接口,构建发布到生产等环境后,如何修改api接口
web前端开发项目走proxy代理后端接口,构建发布到生产等环境后,如何修改api接口
89 0
|
6月前
|
前端开发
开发指南002-前后端信息交互规范-返回类ResponseResult
返回类有两个,一般返回类ResponseResult和分页返回类PageResult,本篇介绍ResponseResult
开发指南002-前后端信息交互规范-概述
前后端之间采用restful接口,服务和服务之间使用feign
|
6月前
|
前端开发
|
XML JSON 前端开发
高德地图Web服务API的开发实例解析
高德地图Web服务API的开发实例解析
337 0
高德地图Web服务API的开发实例解析