基于magic-api+Swagger+Postman快速开发html

1 magic-api介绍

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

上边是官方定义，简单来说就是之前我们开发一个接口，至少需要Controller，Service，Dao，Mapper文件，还需要各种配置，搭建启动springboot项目，发布完成，接口才能访问，接口才算完成。
而magic要做的就是通过UI界面动态的配置一下接口路径，出入参，点击保存，接口发布完成，即可访问，不需要编写代码，只需要简单配置，还支持事物，分页，http请求等数据库操作，有点类似于现在的低代码平台，对于一些非核心的字典呀等静态数据使用还是非常方便的，一款非常优秀的低代码框架，可以快速接口开发。

2 Postman介绍

Postman最早是Google浏览器的一个插件存在的，因为Google退出国内市场，现在postman主要是以一个 APP的形式存在。
Postman最初设计上就是接口测试而设计的，对于测试人员来说主要用来做接口测试。

3 Swagger介绍

一般我们在对接前后端的时候，都需要提供相应的接口文档。对于后端来说，编写接口文档即费时费力，还会经常因为没有及时更新，导致前端对接时出现实际接口与文档不一致。而且手写接口文档还容易出错，而swagger很好的解决了这个痛点。

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。可用于：1.接口的文档在线自动生成、2.功能测试。

4 依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.7.3</version>
            <relativePath/>
    </parent>
    <groupId>cn.tedu</groupId>
    <artifactId>magic-api</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>magic.api</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <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.0.2</version>
        </dependency>
        <dependency>
            <groupId>org.ssssssss</groupId>
            <artifactId>magic-api-spring-boot-starter</artifactId>
            <version>2.0.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.27</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

5 yml

server:
  port: 9999
magic-api:
  #配置web页面入口
  web: /magic/web
  resource:
    #配置文件存储位置。当以classpath开头时，为只读模式
    #mac用户请改为可读写的目录
    #如果不想存到文件中，可以参考配置将接口信息存到数据库、Redis中（或自定义）
    location: D:/data/magic-api
  swagger-config:
    # 文档名称
    name: MagicAPI
    # 文档标题
    title: MagicAPI Swagger Docs
    # 文档描述
    description: MagicAPI
    # 文档版本号
    version: 1.0
    # 文档资源位置
    location: /v2/api-docs/magic-api/swagger2.json

spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/magic_api?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8
    username: root
    password: root
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

6 magic-script脚本

#增
return db.table('magic_api_user').insert(body)
#删
return db.table('magic_api_user').where().eq('id',id).delete()
#改
return db.table('magic_api_user').primary('id').update(body)
#查
return db.table('magic_api_user').select()

7 swagger（项目已集成）

8 Postman自动化测试

致谢：感谢达内支持