若依ruoyi框架整合magic-api增删改查Demo

简介: magic-api增删改查Demo

1.目录结构


2.创建分页Bean


packagecom.ruoyi.web.controller.common;
importorg.ssssssss.magicapi.model.JsonCode;
/*** @ClassName JsonBackBean* @Author Lin* @Date 2021/7/16 10:55 AM* @Version V1.0* @Description**/publicclassPageJsonBackBean<T> {
privateintcode;
privatelongtotal;
privateStringmsg;
privateTrows;
privatelongtimestamp;
privateIntegerexecuteTime;
publicPageJsonBackBean(intcode, Stringmsg) {
this.code=1;
this.msg="success";
this.timestamp=System.currentTimeMillis();
this.code=code;
this.msg=msg;
    }
publicPageJsonBackBean(intcode, Stringmsg, Trows, IntegerexecuteTime) {
this(code, msg, rows);
this.executeTime=executeTime;
    }
publicPageJsonBackBean(longtotal,intcode, Stringmsg, Trows, IntegerexecuteTime) {
this.total=total;
this.code=1;
this.msg="success";
this.timestamp=System.currentTimeMillis();
this.code=code;
this.msg=msg;
this.rows=rows;
this.executeTime=executeTime;
    }
publicPageJsonBackBean(intcode, Stringmsg, Trows) {
this.code=1;
this.msg="success";
this.timestamp=System.currentTimeMillis();
this.code=code;
this.msg=msg;
this.rows=rows;
    }
publicPageJsonBackBean() {
this.code=1;
this.msg="success";
this.timestamp=System.currentTimeMillis();
    }
publicPageJsonBackBean(JsonCodejsonCode) {
this(jsonCode, (T) null);
    }
publicPageJsonBackBean(JsonCodejsonCode, Trows) {
this(jsonCode.getCode(), jsonCode.getMessage(), rows);
    }
publicPageJsonBackBean(Trows) {
this.code=1;
this.msg="success";
this.timestamp=System.currentTimeMillis();
this.rows=rows;
    }
publiclonggetTotal() {
returntotal;
    }
publicvoidsetTotal(longtotal) {
this.total=total;
    }
publicintgetCode() {
returnthis.code;
    }
publicvoidsetCode(intcode) {
this.code=code;
    }
publicStringgetMsg() {
returnthis.msg;
    }
publicvoidsetMsg(Stringmsg) {
this.msg=msg;
    }
publicTgetrows() {
returnthis.rows;
    }
publicvoidsetrows(Trows) {
this.rows=rows;
    }
publiclonggetTimestamp() {
returnthis.timestamp;
    }
publicvoidsetTimestamp(longtimestamp) {
this.timestamp=timestamp;
    }
publicIntegergetExecuteTime() {
returnthis.executeTime;
    }
publicvoidsetExecuteTime(IntegerexecuteTime) {
this.executeTime=executeTime;
    }
}


2.自定义json返回结果


packagecom.ruoyi.web.controller.provider;
importcom.ruoyi.web.controller.common.JsonBackBean;
importcom.ruoyi.web.controller.common.PageJsonBackBean;
importorg.springframework.stereotype.Component;
importorg.ssssssss.magicapi.model.JsonBean;
importorg.ssssssss.magicapi.model.JsonCodeConstants;
importorg.ssssssss.magicapi.model.PageResult;
importorg.ssssssss.magicapi.model.RequestEntity;
importorg.ssssssss.magicapi.provider.ResultProvider;
/*** @Author Lin* @Description  自定义返回结果* @Date 2021/7/16 4:16 PM* @Param * @return **/@ComponentpublicclassCustomJsonValueProviderimplementsResultProvider {
/*** 构建请求结果* @param requestEntity 请求相关信息* @param code          状态码* @param message       状态说明* @param data          数据内容,可以通过data的类型判断是否是分页结果进行区分普通结果集和分页结果集* @return*/@OverridepublicObjectbuildResult(RequestEntityrequestEntity, intcode, Stringmessage, Objectdata) {
// 分页结果if (datainstanceofPageResult) {
PageResult<?>pageResult= (PageResult<?>) data;
longtotal=pageResult.getTotal();
returnnewPageJsonBackBean(total,0,message, pageResult.getList(),1);
        }
//      if (code == JsonCodeConstants.SUCCESS.getCode()) {//          return new JsonBackBean<>(0, message, data);//      }returnnewJsonBean<>(code, message, data);
    }
}


3.自定义分页


packagecom.ruoyi.web.controller.provider;
/*** @ClassName MyPageProvider* @Author Lin* @Date 2021/7/16 11:07 AM* @Version V1.0* @Description **/importorg.springframework.stereotype.Component;
importorg.ssssssss.magicapi.model.Page;
importorg.ssssssss.magicapi.provider.PageProvider;
importorg.ssssssss.script.MagicScriptContext;
/*** 分页对象默认提取接口*/@ComponentpublicclassMyPageProviderimplementsPageProvider {
/***   此方法需要根据实际情况替换*/@OverridepublicPagegetPage(MagicScriptContextcontext) {
longpage=Long.valueOf(context.get("pageNum").toString());
longpageSize=Long.valueOf(context.get("pageSize").toString());
// 计算limit以及offsetreturnnewPage(pageSize, (page-1) *pageSize);
    }
}


4.增加magic-api swagger配置


#Swagger配置swagger:
#是否开启swaggerenabled: truemagic-api:
web: /magic/webresource:
type: database#配置接口存储方式,这里选择存在数据库中table-name: magic_api_file#数据库中的表名prefix: /magic-api#前缀swagger-config:
#资源名称name: MagicAPI#资源描述description: MagicAPIv1.0接口文档#资源位置location: /v2/api-docs/magic-api/swagger2.json#文档版本version: 1.0#文档标题title: MagicAPIv1.0接口文档


5.magic-api接口增删改查demo



新增:


varsql="INSERT INTO cgx_xcx_user( country, province, city, gender, nick_name, phone, wx_num, type, time, scqymc, tyshxydm, fadbr, idstatus, user_name) VALUES (#{country},#{province},#{city},#{gender},#{nickName},#{phone},#{wxNum},#{type},#{time},#{scqymc},#{tyshxydm},#{fadbr},#{idstatus},#{userName})"vari=db.update(sql) 
returnresponse.json({
code : 0,
msg : '新增成功',
result : i});


删除:


//#{id}表示从请求参数或PathVariable中获取参数varsql="delete from cgx_xcx_user where id in (${ids})";    
vari=db.update(sql) 
returnresponse.json({
code : 0,
msg : '删除成功',
result : i});


编辑:


varsql="UPDATE cgx_xcx_user SET  country = #{country}, province = #{province}, city = #{city}, gender = #{gender}, nick_name = #{nickName}, phone = #{phone}, wx_num = #{wxNum}, type = #{type}, time = #{time}, scqymc = #{scqymc}, tyshxydm = #{tyshxydm}, fadbr = #{fadbr}, idstatus = #{idstatus}, user_name = #{userName} WHERE id = #{id}"vari=db.update(sql) 
returnresponse.json({
code : 0,
msg : '更新成功',
result : i});


分页查询: 分页用db.page(sql) 不分页用db.sql(sql),传参:pageNum当前页面,pageSize 显示条数


varsql="select * from cgx_xcx_user";    
varlist=db.page(sql);  //返回Listreturnlist


6.打开若依项目生成代码菜单按如下配置生成代码,zip可生成数据库菜单sql



7.修改生成的前端页面保证和后台magic-api接口访问路径统一



8.测试功能正常,数据库表字段推荐驼峰命名法



9.查看接口生成文档


http://127.0.0.1:5200/swagger-ui/index.html

相关文章
|
2月前
|
API
用 Koa 框架实现一个简单的 RESTful API
用 Koa 框架实现一个简单的 RESTful API
|
3月前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目,定义`Book`实体类、`BookRepository`接口和`BookService`服务类,最后实现`BookController`控制器来处理HTTP请求,展示了从基础环境搭建到API测试的完整过程。
63 4
|
3月前
|
XML JSON API
ServiceStack:不仅仅是一个高性能Web API和微服务框架,更是一站式解决方案——深入解析其多协议支持及简便开发流程,带您体验前所未有的.NET开发效率革命
【10月更文挑战第9天】ServiceStack 是一个高性能的 Web API 和微服务框架,支持 JSON、XML、CSV 等多种数据格式。它简化了 .NET 应用的开发流程,提供了直观的 RESTful 服务构建方式。ServiceStack 支持高并发请求和复杂业务逻辑,安装简单,通过 NuGet 包管理器即可快速集成。示例代码展示了如何创建一个返回当前日期的简单服务,包括定义请求和响应 DTO、实现服务逻辑、配置路由和宿主。ServiceStack 还支持 WebSocket、SignalR 等实时通信协议,具备自动验证、自动过滤器等丰富功能,适合快速搭建高性能、可扩展的服务端应用。
171 3
|
2月前
|
缓存 API 数据库
Python哪个框架合适开发速卖通商品详情api?
在跨境电商平台速卖通的商品详情数据获取与整合中,Python 语言及其多种框架(如 Flask、Django、Tornado 和 FastAPI)提供了高效解决方案。Flask 简洁灵活,适合快速开发;Django 功能全面,适用于大型项目;Tornado 性能卓越,擅长处理高并发;FastAPI 结合类型提示和异步编程,开发体验优秀。选择合适的框架需综合考虑项目规模、性能要求和团队技术栈。
28 2
|
2月前
|
JSON JavaScript 中间件
Koa框架下的RESTful API设计与实现
在现代 Web 开发中,构建高效、可维护的 API 是至关重要的。Koa 是一个流行的 Node.js Web 应用框架,它具有简洁、灵活和强大的特性,非常适合用于设计和实现 RESTful API。
|
2月前
|
开发框架 Java 关系型数据库
Java哪个框架适合开发API接口?
在快速发展的软件开发领域,API接口连接了不同的系统和服务。Java作为成熟的编程语言,其生态系统中出现了许多API开发框架。Magic-API因其独特优势和强大功能,成为Java开发者优选的API开发框架。本文将从核心优势、实际应用价值及未来展望等方面,深入探讨Magic-API为何值得选择。
66 2
|
2月前
|
API PHP 数据库
PHP中哪个框架最适合做API?
在数字化时代,API作为软件应用间通信的桥梁至关重要。本文探讨了PHP中适合API开发的主流框架,包括Laravel、Symfony、Lumen、Slim、Yii和Phalcon,分析了它们的特点和优势,帮助开发者选择合适的框架,提高开发效率、保证接口稳定性和安全性。
72 3
|
2月前
|
JavaScript 中间件 API
Node.js进阶:Koa框架下的RESTful API设计与实现
【10月更文挑战第28天】本文介绍了如何在Koa框架下设计与实现RESTful API。首先概述了Koa框架的特点,接着讲解了RESTful API的设计原则,包括无状态和统一接口。最后,通过一个简单的博客系统示例,详细展示了如何使用Koa和koa-router实现常见的CRUD操作,包括获取、创建、更新和删除文章。
56 4
|
2月前
|
安全 API 数据库
Python哪个框架合适开发淘宝商品详情api?
在数字化商业时代,开发淘宝商品详情API成为企业拓展业务的重要手段。Python凭借其强大的框架支持,如Flask、Django、Tornado和FastAPI,为API开发提供了多样化的选择。本文探讨了这些框架的特点、优势及应用场景,帮助开发者根据项目需求选择最合适的工具,确保API的高效、稳定与可扩展性。
31 0
|
2月前
|
安全 API 网络架构
Python中哪个框架最适合做API?
本文介绍了Python生态系统中几个流行的API框架,包括Flask、FastAPI、Django Rest Framework(DRF)、Falcon和Tornado。每个框架都有其独特的优势和适用场景。Flask轻量灵活,适合小型项目;FastAPI高性能且自动生成文档,适合需要高吞吐量的API;DRF功能强大,适合复杂应用;Falcon高性能低延迟,适合快速API开发;Tornado异步非阻塞,适合高并发场景。文章通过示例代码和优缺点分析,帮助开发者根据项目需求选择合适的框架。
185 0