03- springboot 整合 swagger

6. springboot 整合 swagger

第1步： pom.xml中导入相关的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步：在入口类中增添一个注解 @EnableSwagger2

@SpringBootApplication//入口类
@EnableSwagger2
public class SpringbootSwagerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootSwagerApplication.class, args);
  }
}//类的大括号

第3步：添加一个新的config包，创建一个类SwaggerConfig

@Configuration //表明当前是一个配置类
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("测试接口文档")
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xk.springboot.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("springboot利用swagger构建api文档")
                .description("简单优雅的restful风格，http://blog.csdn.net/saytime")
                .termsOfServiceUrl("http://blog.csdn.net/saytime")
                .version("1.0")
                .build();
    }
}

第4步，创建一个controller包，现在一个test类 先进行测试

@RestController
@ResponseBody
@Api(value = "test模块")
@RequestMapping("/test")
public class SwaggerTest {

    @GetMapping("/demo")
    @ApiOperation(value = "测试get的方法")
    public Object demo(){
        return  "测试get成功～～";
    }

    @PostMapping("/demo")
    @ApiOperation(value = "测试post的方法")
    public Object demo2(@RequestBody Book book){

        return  "测试post成功～～";
    }

    @PutMapping("/demo")
    @ApiOperation(value = "测试put的方法")
    public Object demo3(){

        return  "测试put成功～～";
    }

    @DeleteMapping("/demo")
    @ApiOperation(value = "测试delete的方法")
    public Object demo4(){

        return  "测试delete成功～～";
    }
}

第5步，在controller包下，开始写一个BookTest类

@RestController
@ResponseBody
@Api(value = "book模块")
@RequestMapping("/book")
public class BookTest {
    @Autowired
    private BookService bookService;
    //添加新的数据
    @PutMapping(value="/addBook")
    @ApiOperation(value = "添加新的数据的方法")
    public void addBook(@RequestBody Book book) {
        bookService.addBook(book);
    }

    //更新数据
    @PutMapping(value="/updateBook")
    @ApiOperation(value = "更新数据的方法")
    public void updateBook(@RequestBody Book book) {
        bookService.updateBook(book);
    }

    //删除数据
    @DeleteMapping(value="/deleteBook")
    @ApiOperation(value = "删除数据的方法")
    public void deleteBook(int id) {
        bookService.deleteBook(id);
    }

    //根据id查询
    @PostMapping(value="/queryById")
    @ApiOperation(value = "根据id查询数据的方法")
    public Book queryById(int id) {
        return  bookService.queryById(id);
    }

    //查询所有的方法
    @GetMapping(value="/queryAll")
    @ApiOperation(value = "查询所有的方法")
    public Object queryAll(){
        return bookService.queryAll();
    }
}//类的大括号

http://localhost:8080/swagger-ui.html#