1、官方文档
2、介绍
Magic-API
是一个基于 Java语言,依托于Spring Boot 生态的一个快速开发框架Magic-API
是一个基于Java的接口快速开发框架,编写接口将通过magic-api提供的UI界面完成,自动映射为HTTP接口。 无需定义Controller、Service、Dao、Mapper、XML、VO等Java对象即可完成常见的HTTP API接口开发
3、开始使用
-
创建springboot项目
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.7.12</version> <relativePath/> </parent>
-
导入依赖
<dependency> <groupId>org.ssssssss</groupId> <artifactId>magic-api-spring-boot-starter</artifactId> <version>2.1.1</version> </dependency>
-
yml配置文件
spring: datasource: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://127.0.0.1:3306/shopp?useSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8 username: root password: 123456 jackson: # 日期格式化 date-format: yyyy-MM-dd HH:mm:ss time-zone: GMT+8 magic-api: web: /magic/web # UI请求的界面以及UI服务地址 resource: location: E:\data\magic-api # 本地保存的路径 type: file show-url: true #配置打印SQL response-code: success: 200 #执行成功的code值 exception: 400 #执行出现异常的code值 page: default-page: 1 # 未传页码时的默认首页 default-size: 8 # 未传页大小时的默认页大小 prefix: /api security: # 安全配置 username: admin # 登录用的用户名 password: 123456 # 登录用的密码
-
启动项目
-
直接访问地址,需要输入配置里面的账号密码
-
登录成功后
4、集成swagger
- 导入依赖
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>org.ssssssss</groupId> <artifactId>magic-api-plugin-swagger</artifactId> <version>2.1.1</version> </dependency>
- 添加配置文件
swagger: version: v1.0 description: Demo 接口信息文档 title: Demo接口文档 name: Demo接口文档 location: /v2/api-docs/magic-api/swagger2.json
- 目前Swagger对于spring boot 2.6.0以上版本支持不够友好,需要加入配置
mvc: pathmatch: matching-strategy: ant_path_matcher
- 在启动类上加注解
@EnableSwagger2
- 访问UI页面:
http://127.0.0.1:9999/swagger-ui.html