MyBatis ORM與Swagger集成

MyBatis ORM 和 Swagger 可以很好地集成在一起，以便在一個項目中同時使用它們的功能。MyBatis 是一個優秀的持久層框架，用于簡化數據庫操作，而 Swagger 是一個 API 文檔生成工具，可以幫助開發者自動生成 API 文檔并提供交互式界面。

要將 MyBatis ORM 與 Swagger 集成，你需要按照以下步驟進行操作：

1. 添加依賴

在你的項目中，你需要添加 MyBatis 和 Swagger 的相關依賴。對于 Maven 項目，你可以在 pom.xml 文件中添加以下依賴：

<!-- MyBatis --><dependency>
   <groupId>org.mybatis.spring.boot</groupId>
   <artifactId>mybatis-spring-boot-starter</artifactId>
   <version>2.1.4</version>
</dependency>

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

2. 配置 MyBatis

在你的項目中，你需要配置 MyBatis。例如，你可以在 application.properties 或 application.yml 文件中添加以下配置：

# application.properties
mybatis.mapper-locations=classpath:mapper/*.xml
mybatis.type-aliases-package=com.example.demo.entity

3. 配置 Swagger

接下來，你需要配置 Swagger。在你的項目中，創建一個新的 Java 類（例如 SwaggerConfig.java），并添加以下代碼：

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.any())
                .paths(PathSelectors.any())
                .build();
    }
}

4. 使用 Swagger 注解

現在，你可以在你的 Controller 類中使用 Swagger 注解來描述你的 API。例如：

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Api(tags = "UserController")
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping("/users")
    @ApiOperation("獲取用戶列表")
    public List<User> getUsers() {
        return userService.getUsers();
    }
}

5. 訪問 Swagger UI

最后，你可以通過訪問 Swagger UI 來查看和測試你的 API。在瀏覽器中輸入 http://localhost:8080/swagger-ui.html，你應該可以看到 Swagger UI 頁面，其中包含了你的 API 文檔。

這樣，你就成功地將 MyBatis ORM 和 Swagger 集成到了一個項目中。現在，你可以利用 MyBatis 簡化數據庫操作，同時使用 Swagger 自動生成 API 文檔并提供交互式界面。