magic-api 框架使用

概述

先说一下为什么选择这个框架,在搬砖过程中百分之八十的代码是增删改查操作,复杂的逻辑只是占了不多部分,这个框架能够使简单增删改查的时间大大减少.

magic-api 是一个基于Java的接口快速开发框架，编写接口将通过magic-api提供的UI界面完成，自动映射为HTTP接口，无需定义Controller、Service、Dao、Mapper、XML、VO等Java对象即可完成常见的HTTP API接口开发

简单使用

引用

<dependency>
	<groupId>org.ssssssss</groupId>
	<artifactId>magic-api-spring-boot-starter</artifactId>
    <version>1.4.3</version>
</dependency>

配置

server.port=9999
#配置web页面入口
magic-api.web=/magic/web

使用

启动项目之后，访问http://localhost:9999/magic/web即可看到Web页面



示例地址:
点击 示例
里面有大部分平常使用的示例

其他说明

集成swagger

可配置swagger参数

magic-api:
  swagger-config:
    version: 2.0
    description: MagicAPI 接口信息1
    title: MagicAPI Swagger Docs1
    name: MagicAPI 接口1
    location: /v2/api-docs/magic-api/swagger2.json

访问地址:

http://ip:port/swagger-ui.html

可切换magic-api的接口说明及项目中的接口说明

自定义状态码返回

magic-api:
  response-code-config:
    success: 200 #执行成功的code值
    invalid: 400 #参数验证未通过的code值
    exception: 500 #执行出现异常的code值
  throw-exception: true # 执行出错时，异常将抛出处理

自定义分页

magic-api:
  page-config:
    size: size # 页大小的请求参数名称
    page: page # 页码的请求参数名称
    default-page: 1 # 未传页码时的默认首页
    default-size: 10 # 未传页大小时的默认页大小

UI鉴权登录

magic-api:
  security-config: # UI鉴权登录
    username: admin # 登录用的用户名
    password: 123456 # 登录用的密码

返回时间处理

spring:
  jackson: # 返回的JSON日期的格式
    time-zone: GMT+8
    date-format: yyyy-MM-dd HH:mm:ss

其他具体使用说明详见:
官方文档
界面操作示例