Swagger结合springboot使用_swagger com.spring4all-CSDN博客

本文链接：https://blog.csdn.net/lixld/article/details/100512521

本文介绍了如何在SpringBoot项目中集成Swagger，包括环境配置、依赖引入、Swagger配置Bean、定义RESTful接口以及Swagger常用注解的使用。通过启用@EnableSwagger2启动Swagger，并通过@Api、@ApiOperation等注解进行接口和参数的文档化描述。启动项目后，访问http://localhost:8080/swagger-ui.html可查看Swagger UI。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.环境

SpringBoot   2.0.4.RELEASE
Swagger   1.7.1
JDK   1.8

2.依赖

<dependency>
	<groupId>com.spring4all</groupId>
	<artifactId>swagger-spring-boot-starter</artifactId>
	<version>1.7.1.RELEASE</version>
</dependency>

3.Swagger配置Bean
@Configuration会被项目启动加载为配置类,等同于XML中配置的beans；
@Bean标注方法等同于XML中配置的bean。

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

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("xx系统")
                .description("xxx模块")
                .contact("xxxxxx")
                .version("1.0")
                .build();
    }

启动类中加入@EnableSwagger2 代表swagger开启:

@EnableScheduling
@SpringBootApplication
@EnableSwagger2
@EnableCaching
@ComponentScan(basePackages={"com.xx"})
@EnableJpaRepositories
public class Application {

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

4.定义restful接口

@RestController
@RequestMapping("web/address")
@Api(value="地址管理模块")
public class AddressController {
	@Autowired
	IAddressService addressService;

	@BussinessLog("获取地区")
	@RequestMapping(value = "getList")
	@ApiOperation(value="获取地区",notes="根据id获取地址列表" produces = "application/json",httpMethod="GET")
	public ResponseResult<List<APIAddressResponse>> list(Integer pid) {
		 return ResponseResult.SUCCESS(apiAddressTree);
	}
	
}