【SSM基础】Swagger、Knife4j使用

【SSM基础】Swagger、Knife4j使用

其他文章： bookcase微服务实战

1、前言

现在的项目大多是前后端分离，写完之后调试比较麻烦，假如有一种方式可以像java doc展示自己编写的接口，那么就可以加快我们开发的进度。
Swagger就是这么一种技术，而Knife4j 是对Swagger的再度封装，界面更加友好，推荐使用。

2、使用

2.1、Swagger 使用

• 添加依赖

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

• 添加配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                .apis(RequestHandlerSelectors.any()).paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().build();
    }

}

Controller 配置 Swagger 访问：

@RestController
@RequestMapping("/book")
@Api(value = "书籍管理", tags = "书籍管理")
@RequiredArgsConstructor
public class BookController {

    private final IBookService bookService;

    @GetMapping(value = "/getByName")
    @ApiOperation(value = "根据名称查询书籍信息", notes = "根据名称查询书籍信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "name",value = "书籍名称",required = true)
    })
    public IPage<Book> getBookById(@RequestParam String name) {
        return bookService.selectBooksByName(name);
    }
}

访问地址：http://localhost:8081/swagger-ui.html

2.2、knife4j

用了swagger你会感觉，界面不太友好，推荐使用国内封装的knife4j，官网地址：https://doc.xiaominfo.com/knife4j/documentation/
这里使用2.0.9版本。

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <!--在引用时请在maven中央仓库搜索2.X最新版本号-->
    <version>2.0.9</version>
</dependency>

Controller 配置 Swagger 访问,这里和 Swagger 相同，也就是假如之前使用Swagger这里可以直接切换：

@RestController
@RequestMapping("/book")
@Api(value = "书籍管理", tags = "书籍管理")
@RequiredArgsConstructor
public class BookController {

    private final IBookService bookService;

    @GetMapping(value = "/getByName")
    @ApiOperation(value = "根据名称查询书籍信息", notes = "根据名称查询书籍信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "name",value = "书籍名称",required = true)
    })
    public IPage<Book> getBookById(@RequestParam String name) {
        return bookService.selectBooksByName(name);
    }
}

访问地址： http://localhost:8081/doc.html

访问界面如下：

3、总结

妈妈再也不用担心，我前后端联调麻烦，接口表述不清，内部开发还需要写文档等各种问题了。