6. springboot 整合 swagger
第1步： pom.xml中導(dǎo)入相關(guān)的jar包
<!--添加swagger2依賴的jar包-->
<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>
第2步：在入口類中增添一個(gè)注解 @EnableSwagger2
@SpringBootApplication//入口類
@EnableSwagger2
public class SpringbootSwagerApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootSwagerApplication.class, args);
}
}//類的大括號(hào)
第3步：添加一個(gè)新的config包，創(chuàng)建一個(gè)類SwaggerConfig
@Configuration //表明當(dāng)前是一個(gè)配置類
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName("測(cè)試接口文檔")
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.xk.springboot.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("springboot利用swagger構(gòu)建api文檔")
.description("簡(jiǎn)單優(yōu)雅的restful風(fēng)格睹欲，http://blog.csdn.net/saytime")
.termsOfServiceUrl("http://blog.csdn.net/saytime")
.version("1.0")
.build();
}
}
第4步漓骚，創(chuàng)建一個(gè)controller包，現(xiàn)在一個(gè)test類 先進(jìn)行測(cè)試
@RestController
@ResponseBody
@Api(value = "test模塊")
@RequestMapping("/test")
public class SwaggerTest {
@GetMapping("/demo")
@ApiOperation(value = "測(cè)試get的方法")
public Object demo(){
return "測(cè)試get成功～～";
}
@PostMapping("/demo")
@ApiOperation(value = "測(cè)試post的方法")
public Object demo2(@RequestBody Book book){
return "測(cè)試post成功～～";
}
@PutMapping("/demo")
@ApiOperation(value = "測(cè)試put的方法")
public Object demo3(){
return "測(cè)試put成功～～";
}
@DeleteMapping("/demo")
@ApiOperation(value = "測(cè)試delete的方法")
public Object demo4(){
return "測(cè)試delete成功～～";
}
}
第5步诊沪，在controller包下除盏，開始寫一個(gè)BookTest類
@RestController
@ResponseBody
@Api(value = "book模塊")
@RequestMapping("/book")
public class BookTest {
@Autowired
private BookService bookService;
//添加新的數(shù)據(jù)
@PutMapping(value="/addBook")
@ApiOperation(value = "添加新的數(shù)據(jù)的方法")
public void addBook(@RequestBody Book book) {
bookService.addBook(book);
}
//更新數(shù)據(jù)
@PutMapping(value="/updateBook")
@ApiOperation(value = "更新數(shù)據(jù)的方法")
public void updateBook(@RequestBody Book book) {
bookService.updateBook(book);
}
//刪除數(shù)據(jù)
@DeleteMapping(value="/deleteBook")
@ApiOperation(value = "刪除數(shù)據(jù)的方法")
public void deleteBook(int id) {
bookService.deleteBook(id);
}
//根據(jù)id查詢
@PostMapping(value="/queryById")
@ApiOperation(value = "根據(jù)id查詢數(shù)據(jù)的方法")
public Book queryById(int id) {
return bookService.queryById(id);
}
//查詢所有的方法
@GetMapping(value="/queryAll")
@ApiOperation(value = "查詢所有的方法")
public Object queryAll(){
return bookService.queryAll();
}
}//類的大括號(hào)
