开箱即用之Swagger配置

半自定义大剑仙

已于 2023-12-26 16:38:50 修改

阅读量242

点赞数

分类专栏：开箱即用文章标签： java

于 2023-01-30 15:02:31 首次发布

本文链接：https://blog.csdn.net/2301_76354366/article/details/128802436

版权

开箱即用专栏收录该内容

35 篇文章 0 订阅

订阅专栏

添加Swagger所需要的依赖

<!--Swagger依赖-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.8.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.8.0</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.6</version>
</dependency>

创建swagger配置类


@Configuration
@EnableSwagger2
public class SwaggerConfig
{

    @Bean
    public Docket createRestApi()
    {
        return new Docket(DocumentationType.SWAGGER_2).useDefaultResponseMessages(false).apiInfo(apiInfo()).select()
                .apis(RequestHandlerSelectors.basePackage("注解添加的包")).paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo()
    {
        return new ApiInfoBuilder().title("swagger文档标题").description("接口文档").version("1.0.0").build();
    }
}

开启Swagger配置

第一种方式，在配置文件中进行Swagger激活
#swagger激活
swagger.enable=true

第二种方式，在主启动类上添加注解启动
@EnableSwagger2

Swagge常用注解


#作用在Controller接口上
@Api(tags = "",description = "")

#作用在Controller接口调用的方法上
@ApiOperation(value = "",httpMethod ="GET")

#屏蔽某个接口方法使其不暴露
@ApiIgnore 

#用在方法内，参数校验及说明
@ApiParam 

#作用在实体类对象上，解释说明
@ApiModel(value = "")

#作用在实体类字段属性上，解释说明
@ApiModelProperty(value = "")