SpringBoot可视化接口开发工具magic-api的简单使用教程

介绍

magic-api是一款SpringBoot可视化接口开发工具，可以让开发人员在图形化界面上快速构建RESTful API接口。其特点是通过简单的配置即可生成接口代码，支持对接口文档的在线管理和修改。

安装

首先，你需要在项目的pom.xml文件中添加magic-api的依赖：

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>magic-api</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>

然后，为了让Spring Boot加载magic-api并使其生效，你需要在你的启动类中添加一个@EnableMagicApi注解：

@SpringBootApplication
@EnableMagicApi
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

这样一来，你就可以通过访问http://localhost:8080/magic-api来访问magic-api的操作界面了。

配置

在操作界面上，你可以看到左侧栏目中有几个配置项可以选择修改，包括“应用配置”、“API配置”等。下面我们以“API配置”为例来说明如何进行配置。

1. 新建一个RESTful API

首先，点击API配置栏目下的“+”按钮，进入新建API的界面。你可以在这里填写API的基础信息，例如URL、请求方法、请求参数等等。

1. 添加模板

在新建API的界面中，你可以添加模板来快速生成API的代码。模板是一个基于Freemarker语法的文件，你可以在里面编写生成代码的逻辑。

下面是一个示例模板，用于生成一个返回Hello, world!的GET请求：

<#import "api.ftl" as magic>
<#macro generator magic.service.api.generator>

<#generator url="/hello" method="get">
@GetMapping("/hello")
public String hello() {
    return "Hello, world!";
}
</#generator>

</#macro>

在模板中你可以使用magic.service.api.generator宏来生成接口代码，具体语法和功能可查看官方文档。

1. 生成代码

完成模板编辑之后，点击页面下方的“生成代码”按钮，你就可以看到自动生成的接口代码了。

示例

1. 生成一个返回当前时间的接口

首先，我们需要新建一个RESTful API，包括URL、请求方法等信息。假设我们的URL为/time，请求方法为GET。

然后，我们可以在模板中编写生成当前时间的代码：

<#import "api.ftl" as magic>
<#macro generator magic.service.api.generator>

<#generator url="/time" method="get">
@GetMapping("/time")
public String time() {
    return new Date().toString();
}
</#generator>

</#macro>

生成代码之后，我们就可以在浏览器中访问http://localhost:8080/time来获取当前时间了。

1. 生成一个查询用户列表的接口

假设我们已经有一个用户实体类User，包括id和name字段。我们需要生成一个查询用户列表的接口，包括分页和排序功能。

首先，我们可以在API配置界面的“参数定义”栏目下定义请求参数，包括页码、每页数量和排序方式等等。

然后，我们可以在模板中编写生成查询用户列表的代码：

<#import "api.ftl" as magic>
<#macro generator magic.service.api.generator>

<#generator url="/users" method="get"
    query="page,size,sort"
    query_default="page=0,size=10,sort=id,desc">
@GetMapping("/users")
public Page<User> getUsers(@RequestParam MultiValueMap<String, String> params) {
    Pageable pageable = magic.service.api.util.PageUtil.toPageable(params);

    // 排序
    Sort sort = pageable.getSort();
    if (sort.isUnsorted()) {
        sort = Sort.by(Sort.Direction.DESC, "id");
    }

    // 获取数据
    return userRepository.findAll(pageable);
}
</#generator>

</#macro>

生成代码之后，我们就可以在浏览器中访问http://localhost:8080/users?page=0&size=10&sort=id,desc来查询用户列表了。

结论

magic-api是一款方便易用的接口开发工具，可以帮助开发人员快速构建RESTful API接口。通过学习本教程，您可以掌握magic-api的安装、配置和使用方法，并且可以通过示例代码来学习如何使用模板来生成接口代码。