在SpringBoot中集成Swagger

集成 Swagger

swagger 用于帮助我们自动生成 API 文档，节省了维护文档的时间，我们很多时候在开发接口过程中通过 wagger-ui 进行 API 测试。

首先将以下依赖添加到 pom.xml 文件中

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

在 Application.java 中添加 @EnableSwagger2 注解启用 Swagger2。 注意代码中出现 // … 表示有部分未修改的代码被省略。

// ...
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2 // 启用 Swagger2
public class Application extends SpringBootServletInitializer {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
// ...

在 GreetController 中使用 @ApiOperation 注解对接口进行说明。

// ...
import io.swagger.annotations.ApiOperation;
// ...
    @GetMapping("/greet") // 从 "/" 修改为 "/greet"
    @ApiOperation("打个招呼") // 对接口进行说明
    public String greet() {
        return "hello world";
    }
// ...

完成后关闭之前启动的服务，再次执行 mvn spring-boot:run 命令构建项目并启动服务。

成功启动后打开 https://…/swagger-ui.html 页面可以看到我们的 “/greet” 接口的文档。

点击 Try it out! 立即调用接口，可以看到 Response Body 返回 hello world 字符串。