SpringBoot2 MyBatis集成Swagger文档

发布时间:2024-11-05 15:15:16 作者:小樊
来源:亿速云 阅读:79

在Spring Boot 2中集成Swagger生成API文档,你需要遵循以下步骤:

  1. 添加依赖

在你的pom.xml文件中添加Swagger和MyBatis的依赖:

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- MyBatis Starter -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-mybatis</artifactId>
    </dependency>

    <!-- Swagger Starter -->
    <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>

    <!-- MySQL Connector -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>
  1. 配置Swagger

创建一个配置类SwaggerConfig.java,用于配置Swagger:

import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

这里,我们使用@EnableSwagger2注解启用Swagger2,并使用Docket类创建一个API文档实例。RequestHandlerSelectors.basePackage("com.example.demo.controller")表示只扫描com.example.demo.controller包下的控制器类。

  1. 创建实体类

创建一个简单的实体类User.java,用于测试API文档:

public class User {
    private Long id;
    private String name;
    private Integer age;

    // 省略getter和setter方法
}
  1. 创建Mapper接口

创建一个MyBatis的Mapper接口UserMapper.java,用于操作User实体类:

import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

import java.util.List;

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM user")
    List<User> findAll();
}
  1. 创建控制器

创建一个控制器UserController.java,用于处理HTTP请求:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class UserController {
    @Autowired
    private UserMapper userMapper;

    @GetMapping("/users")
    public List<User> findAll() {
        return userMapper.findAll();
    }
}
  1. 访问Swagger文档

启动你的Spring Boot应用,然后在浏览器中访问http://localhost:8080/swagger-ui.html,你将看到Swagger生成的API文档。

注意:如果你的项目中有多个包需要扫描,可以将RequestHandlerSelectors.basePackage("com.example.demo.controller")中的com.example.demo.controller替换为你的实际包名。

推荐阅读:
  1. SpringBoot整合Swagger2实例方法
  2. SpringBoot结合swagger2如何生成接口文档

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

mybatis

上一篇:MyBatis在SpringBoot2中的日志记录

下一篇:MyBatis在SpringBoot2中的SQL监控

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》