Swagger是一種API文檔生成工具,它可以與多種框架協同工作,以便為開發者提供方便、統一的API文檔和測試界面。以下是Swagger與Spring Boot框架集成的方法:
<dependency>
<groupId>com.mangofactory</groupId>
<artifactId>swagger-springmvc</artifactId>
<version>1.0.2</version>
</dependency>
<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>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.7.5</version>
</dependency>
@EnableSwagger2
注解啟用Swagger,并定義API文檔的相關配置。@Configuration
@EnableSwagger2
public class MySwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
@Controller
@RequestMapping("/api")
public class ApiController {
@ApiOperation(value = "測試專用")
@RequestMapping(value = "/test", method = RequestMethod.GET)
@ResponseBody
public String test() {
return "123";
}
}
http://localhost:8080/swagger-ui.html
來查看和測試API文檔。以上步驟展示了如何在Spring Boot應用中集成Swagger,使得API文檔的生成和測試變得簡單快捷。通過這種方式,開發者可以在不離開開發環境的情況下,實時地看到API文檔的更新,從而提高開發效率。