简介magic-api是一个基于Java的接口快速开发框架编写接口将通过magic-api提供的UI界面完成自动映射为HTTP接口。 无需定义Controller、Service、Dao、Mapper、XML、VO等Java对象即可完成常见的HTTP API接口开发。官方文档地址https://www.ssssssss.org/magic-api/pages/quick/intro/参数配置说明一、基础访问配置参数作用可选值默认值magic-api.web可视化控制台的访问路径任意有效URL路径/magic/webmagic-api.prefix所有Magic API接口的统一外部请求前缀任意有效URL路径无二、接口存储配置resource参数作用可选值默认值magic-api.resource.type接口脚本的存储方式file、database、redisfilemagic-api.resource.location文件存储模式下的存储目录任意有效文件系统路径无magic-api.resource.table-name数据库存储模式下的数据表名任意有效表名magic_api_filemagic-api.resource.datasource多数据源场景下指定使用的数据源名称数据源Bean名称默认主数据源magic-api.resource.prefix数据库/Redis存储时的Key前缀任意字符串/magic-apimagic-api.resource.readonly是否为只读模式true、falsefalse三、分页配置page参数作用可选值默认值magic-api.page.page页码的请求参数名称任意字符串pagemagic-api.page.size页大小的请求参数名称任意字符串sizemagic-api.page.default-page未传页码时的默认值正整数1magic-api.page.default-size未传页大小时的默认值正整数10四、响应码配置response-code参数作用可选值默认值magic-api.response-code.success执行成功时返回的状态码任意整数1magic-api.response-code.invalid参数验证未通过时的状态码任意整数0magic-api.response-code.exception执行异常时的状态码任意整数-1五、备份配置backup参数作用可选值默认值magic-api.backup.enable是否启用接口修改的自动备份true、falsefalsemagic-api.backup.max-history备份记录保留天数-1为永久保留-1或正整数-1magic-api.backup.table-name备份记录存储的表名任意有效表名magic_backup_record_v2六、安全认证配置security参数作用可选值默认值magic-api.security.username控制台登录用户名任意字符串无不启用认证magic-api.security.password控制台登录密码任意字符串无不启用认证七、Swagger文档配置swagger参数作用可选值默认值magic-api.swagger.name文档名称任意字符串MagicAPImagic-api.swagger.title文档标题任意字符串MagicAPI Swagger Docsmagic-api.swagger.description文档描述任意字符串MagicAPImagic-api.swagger.version文档版本号任意字符串1.0magic-api.swagger.locationSwagger JSON文档访问路径任意有效路径/v2/api-docs/magic-api/swagger2.json需要引入magic-api-plugin-swagger依赖才能生效。八、集群配置cluster参数作用可选值默认值magic-api.instanceId集群环境下标识不同实例的ID任意字符串随机生成magic-api.cluster.channelRedis发布订阅的通知通道名称任意字符串magic-api:notify:channel需要引入magic-api-plugin-cluster依赖才能生效。九、其他配置参数作用可选值默认值magic-api.sql-column-caseSQL查询结果列名转换规则例如user_name转userNamecamel驼峰命名无转换magic-api.response控制返回结果的包装格式data直接返回原始数据默认包装为{code, message, data}magic-api.show-urlidea控制台输出magic-api接口配置页访问地址truefalse空默认true配置文件信息配置文件中的配置项实际使用中按需配置properties版# 一、基础访问配置 # 可视化控制台的访问路径 magic-api.web/magic/web # 所有Magic API接口的统一外部请求前缀 magic-api.prefix/magic-api # 二、接口存储配置resource # 存储类型file本地文件、database数据库、redisRedis magic-api.resource.typedatabase # 文件存储模式下的存储目录type: file 时生效 magic-api.resource.location./magic-api # 数据库存储模式下的数据表名type: database 时生效 magic-api.resource.table-namemagic_api_file # 多数据源场景下指定使用的数据源名称 magic-api.resource.datasourcemaster # 数据库/Redis存储时的Key前缀仅用于数据隔离 magic-api.resource.prefix/magic-api # 是否为只读模式true时控制台无法增改接口 magic-api.resource.readonlyfalse # 三、分页配置page # 页码的请求参数名称 magic-api.page.pagepage # 页大小的请求参数名称 magic-api.page.sizesize # 未传页码时的默认值 magic-api.page.default-page1 # 未传页大小时的默认值 magic-api.page.default-size10 # 四、响应码配置response-code # 执行成功时返回的状态码 magic-api.response-code.success200 # 参数验证未通过时的状态码 magic-api.response-code.invalid400 # 执行异常时的状态码 magic-api.response-code.exception500 # 五、备份配置backup # 是否启用接口修改的自动备份 magic-api.backup.enabletrue # 备份记录保留天数-1为永久保留 magic-api.backup.max-history30 # 备份记录存储的表名 magic-api.backup.table-namemagic_backup_record_v2 # 六、安全认证配置security # 控制台登录用户名 magic-api.security.usernameadmin # 控制台登录密码 magic-api.security.password123456 # 七、Swagger文档配置swagger # 文档名称 magic-api.swagger.nameMagicAPI # 文档标题 magic-api.swagger.titleMagicAPI Swagger Docs # 文档描述 magic-api.swagger.descriptionMagicAPI # 文档版本号 magic-api.swagger.version1.0 # Swagger JSON文档访问路径 magic-api.swagger.location/v2/api-docs/magic-api/swagger2.json # 八、集群配置cluster # 集群环境下标识不同实例的ID magic-api.instanceIdnode-1 # Redis发布订阅的通知通道名称 magic-api.cluster.channelmagic-api:notify:channel # 九、其他配置 # SQL查询结果列名转换规则camel 驼峰命名 magic-api.sql-column-casecamel # 控制返回结果的包装格式data 直接返回原始数据 magic-api.responsedatayaml版magic-api:# 一、基础访问配置 # 可视化控制台的访问路径web:/magic/web# 所有Magic API接口的统一外部请求前缀prefix:/magic-api# 二、接口存储配置resource resource:# 存储类型file本地文件、database数据库、redisRedistype:database# 文件存储模式下的存储目录type: file 时生效location:./magic-api# 数据库存储模式下的数据表名type: database 时生效table-name:magic_api_file# 多数据源场景下指定使用的数据源名称datasource:master# 数据库/Redis存储时的Key前缀仅用于数据隔离prefix:/magic-api# 是否为只读模式true时控制台无法增改接口readonly:false# 三、分页配置page page:# 页码的请求参数名称page:page# 页大小的请求参数名称size:size# 未传页码时的默认值default-page:1# 未传页大小时的默认值default-size:10# 四、响应码配置response-code response-code:# 执行成功时返回的状态码success:200# 参数验证未通过时的状态码invalid:400# 执行异常时的状态码exception:500# 五、备份配置backup backup:# 是否启用接口修改的自动备份enable:true# 备份记录保留天数-1为永久保留max-history:30# 备份记录存储的表名table-name:magic_backup_record_v2# 六、安全认证配置security security:# 控制台登录用户名username:admin# 控制台登录密码password:123456# 七、Swagger文档配置swagger swagger:# 文档名称name:MagicAPI# 文档标题title:MagicAPI Swagger Docs# 文档描述description:MagicAPI# 文档版本号version:1.0# Swagger JSON文档访问路径location:/v2/api-docs/magic-api/swagger2.json# 八、集群配置cluster # 集群环境下标识不同实例的IDinstanceId:node-1cluster:# Redis发布订阅的通知通道名称channel:magic-api:notify:channel# 九、其他配置 # SQL查询结果列名转换规则camel 驼峰命名sql-column-case:camel# 控制返回结果的包装格式data 直接返回原始数据response:data集成运行演示引入依赖!--magicapi接口客户端--dependencygroupIdorg.ssssssss/groupIdartifactIdmagic-api-spring-boot-starter/artifactIdversion2.2.2/version/dependency添加配置演示集成数据库版本需配置数据源连接信息添加配置信息以application.properties为例。#web接口url路径访问前缀 magic-api.web/magic/web #数据库存储策略 magic-api.resource.typedatabase #数据库存储表名 magic-api.resource.table-namemagic_api_file #数据库存储数据路径前缀 magic-api.resource.prefix/magic-api #允许修改删除编辑接口 magic-api.resource.readonlyfalse #开启接口备份 magic-api.backup.enabletrue #备份近一个月接口记录 magic-api.backup.max-history30 #备份表表名 magic-api.backup.table-namemagic_backup_record_v2 #为magic-api运行时默认数据源且接口信息与备份记录都存储在该库中 spring.datasource.driver-class-nameorg.postgresql.Driver spring.datasource.urljdbc:postgresql://localhost:5432/postgres spring.datasource.usernameadcMmHIL5J6l0ySvB9mGoQ3/GE1ZFra4nRJb2yPPqoYlzDteaV7DEu/sHxblIe26Rxef spring.datasource.passwordadc9M3EzFyWKz0oFcN4WEjb/0oj6mr0EsiNRoD60sRtwNojO6sY8pY4J2Hmus5OQmOef运行结果日志输出访问预览