springboot集成swagger-ui的简单demo

基本步骤如下：

1.在pom.xml中添加swagger依赖

        <!--swagger相关包-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.2.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.2.2</version>
        </dependency>

3.创建swagger配置类

@Configuration
@EnableSwagger2
public class Swagger2 {

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

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                .description("锤锤的第一个swagger-ui")
                .termsOfServiceUrl("http://blog.didispace.com/")
                .contact("小锤锤")
                .version("1.0")
                .build();
    }
}

3.添加文档内容

@Api(description = "获取用户列表API")
@RestController
@RequestMapping(value="/users")  
public class UserController {
    
    @ApiOperation(value="获取用户列表")
    @GetMapping("")
    public String getUserList() {
        return "swagger-ui 成功过啦!";
    }
}

4.启动springboot,访问http://localhost:8081/swagger-ui.html，会看到如下页面就成功啦！