Springboot与Swagger协作指导，助你轻松生成文档

后端

2023-10-03 09:09:42

前言

在软件开发领域，Swagger早已成为生成实时接口文档的热门选择。本文将深入剖析Springboot与Swagger的结合之道，为你揭示轻松生成文档的奥秘。

一、何为Swagger

Swagger是一个强大的开源工具，它能够为RESTful API提供互动式的在线文档。有了它，开发者可以轻松地理解和使用API，从而简化API的设计、开发和维护流程。

二、Springboot集成Swagger的步骤

1. 添加依赖

在项目中添加Swagger的依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>

2. 配置Swagger

在Springboot项目中配置Swagger：

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

3. 启动Swagger

在项目中启动Swagger：

@SpringBootApplication
public class SpringbootSwaggerApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootSwaggerApplication.class, args);
    }
}

三、接口文档的生成与访问

完成以上配置后，Swagger便可自动生成接口文档。你可通过访问以下路径来查看：

http://localhost:8080/swagger-ui/index.html

四、示例

为了便于理解，现提供一个Springboot与Swagger集成并生成文档的示例：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class SpringbootSwaggerApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootSwaggerApplication.class, args);
    }

    @RestController
    @RequestMapping("/api")
    class ApiController {

        @GetMapping("/hello")
        public String hello() {
            return "Hello, World!";
        }
    }
}