2020-12-10 SpringBoot 项目集成Swagger 详细教程

第一步:pom.xml配置

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

第二步：配置swagger
在类路径下新建配置类SwaggerConfig

@Configuration
@EnableSwagger2
public class SwaggerConfig {


    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //在controller包下以及子包下的controller类,你放其他包下可能就没用了
                .apis(RequestHandlerSelectors.basePackage("com.xxx.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://项目实际地址/swagger-ui.html
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Lucas的User表测试接口") //就是说这个界面叫什么名字
                .description("Lucas会变强的") //对这个界面的描述
                .build();
    }
}

最后就是配置Controller，添加注解 (这里只是拿了两个api当作例子)

	@ApiOperation(value = "创建一个user")
    @PostMapping("/user")
    public User saveUser(@RequestBody User user){
        return userService.save(user);
    }


    /**
     *      获取所有的user
     * @return
     */
    @ApiOperation(value = "获取所有的user")
    @GetMapping("/users")
    public List<User> getAllUsers(){
        return userService.getAllUser();
    }

启动运行，访问 http://localhost:8080/swagger-ui.html ，显示效果

cool！