【SpringBoot】使用swagger生成html文档

前言

对于前后端分离的项目来说，这个时候往往需要接口文档，进行前后端联调。这个时候可以采用使用swagger插件来生成html文档来作为接口文档进行开发

应用

1、引入依赖

<!--swagger核心包-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <!--swagger-ui包-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

2、配置相应的注解
启动类开启swagger

注解	使用场景
@ApiOperation(value=”用户查询服务”)	方法名
@ApiModelProperty(value=”用户名”) private String username;	传入参数为实体类型的时候，需要在实体属性加入该注解
public void delete(@ApiParam(value=”用户id”)@PathVariableStringid){	传入参数为单个对象类型，需要在传入参数加入该注解

3、效果图

小结

参考如下链接：https://blog.csdn.net/u014231523/article/details/76522486