swagger2介绍与使用

沉淀1958

于 2024-01-28 12:19:56 发布

阅读量450

点赞数 1

分类专栏：教程文章标签： java 开发语言

本文链接：https://blog.csdn.net/m0_46568965/article/details/135893686

版权

教程专栏收录该内容

9 篇文章

订阅专栏

本文介绍了Swagger2在接口文档编写中的应用，包括常用注解的使用，如何在SpringBoot项目中集成Swagger2，以及配置示例和最终效果展示。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、swagger2介绍

什么是swagger2：

编写和维护接口文档是每个程序员的职责，Swagger2可以快速帮助我们编写最新的API接口文档，提升了团队开发的沟通效率。

常用注解

swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。

@Api：修饰整个类，描述Controller的作用（ @Api(tags = "hospitalSet管理") ）

@ApiOperation：描述一个类的一个方法，或者说一个接口（@ApiOperation(value = "获取所有医院设置")）

@ApiParam：单个参数描述

@ApiModel：用对象来接收参数

@ApiModelProperty：用对象接收参数时，描述对象的一个字段

@ApiImplicitParam：一个请求参数

@ApiImplicitParams：多个请求参数

2、项目整合swagger2

（1）在pom.xml文件中引入依赖

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

（2）添加swagger2配置类


import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger2配置信息
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                //只显示api路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/api/.*")))
                .build();
    }

    @Bean
    public Docket adminApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("adminApi")
                .apiInfo(adminApiInfo())
                .select()
                //只显示admin路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/admin/.*")))
                .build();
    }

    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("网站-API文档")
                .description("本文档描述了网站微服务接口定义")
                .version("1.0")
                .contact(new Contact("ustc", "https://www.ustc.edu.cn/", "1811875024@qq.com"))
                .build();
    }

    private ApiInfo adminApiInfo(){
        return new ApiInfoBuilder()
                .title("后台管理系统-API文档")
                .description("本文档描述了后台管理系统微服务接口定义")
                .version("1.0")
                .contact(new Contact("ustc", "https://www.ustc.edu.cn/", "1811875024@qq.com"))
                .build();
    }

}

3、效果展示

访问链接为：http://localhost:8201/swagger-ui.html