架构实战篇（三）-Spring Boot架构搭建RESTful API案例

最新推荐文章于 2024-08-20 05:32:30 发布

IT实战联盟Lin

最新推荐文章于 2024-08-20 05:32:30 发布

阅读量2.6k

点赞数 1

分类专栏：互联网技术移动开发 java-web 文章标签： spring api 架构可视化

本文链接：https://blog.csdn.net/zhenghhgz/article/details/79289241

版权

本文详细介绍了如何在Spring Boot基础上搭建RESTful API，包括添加Maven依赖，创建查询Form类，编写查询语句，更新Mapper和服务层代码，以及设置API接口。通过实例展示了查询操作，并提供了测试步骤和结果。

摘要由CSDN通过智能技术生成

IT实战联盟博客：http://blog.100boot.cn
这里写图片描述

前言

上一篇分享了Spring Boot 整合Swagger 让API可视化和前后端分离架构受到了大家一致好评，本节就接着上节的代码做了详细的查询代码的补充和完善并搭建RESTful API架构案例。

注意: 本节代码都是在上节代码的基础上追加的内容，如果需要源码的可以去看上节内容或者关注我们的公众号，回复 MyBatis（二）和你的邮箱地址，我们发送给你。

点我！传送到上节 - Spring Boot 整合MyBatis

我们先看下已经完成的项目结构图

项目结构

如果看过上节文章的同学应该注意到Code 和 Result 怎么没有了？那是因为为了节省篇幅我们用Spring提供的ResponseEntity 类代替了

最终运行结果

下面开始一步一步的编写代码了

增加Spring boot的maven 依赖

在原有基础的pom结构中追加Swagger2的依赖

        <!-- swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

增加一个查询用的Form类

里面使用到了swagger 的注解

import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
import java.util.List;

public class HelpCategoryForm implements Serializable {
   
    // 查询条件
    @ApiModelProperty(value = "分类编号集合")
    private List<Integer> idList;
    @ApiModelProperty(value = "模糊查询分类名称")
    private String nameLike;
    @ApiModelProperty(value = "父类编号")
    private Integer parentId;
    // 分页
    @ApiModelProperty(value = "第几页", example = "1")
    private Integer pageNum;
    @ApiModelProperty(value = "显示行数", example = "10")
    private Integer pageSize;
    // 排序
    @ApiModelProperty(value = "排序", allowableValues = "help_category_id,name",
            notes = "(后面空格追加 升序ASC, 降序DESC), 例如: name asc 或者 name desc")
    private String orderBy;
    
    // 省略了get set 方法