在springboot中使用swagger!!

最新推荐文章于 2025-03-18 11:10:48 发布

原创最新推荐文章于 2025-03-18 11:10:48 发布

· 990 阅读

0 ·

版权

快速搭建一个swagger

1.首先创建一个springboot项目,勾上web->spring web
在这里插入图片描述
2.在pom.xml中添加swagger依赖

<!--        swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

3.编写SwaggerConfig配置类,在类上加上@Configuration@EnableSwagger2注解在这里插入图片描述
4.编写controller测试能否跑通

常用注解

Swagger注解	简单说明
@Api(tags = “xxx模块说明”)	作用在模块类上
@ApiOperation(“xxx接口说明”)	作用在接口方法上
@ApiModel(“xxxPOJO说明”)	作用在模型类上：如VO、BO
@ApiModelProperty(value = “xxx属性说明”,hidden = true)	作用在类方法和属性上，hidden设置为true可以隐藏该属性
@ApiParam(“xxx参数说明”)	作用在参数、方法和字段上，类似@ApiModelProperty