Swagger2集成

最新推荐文章于 2024-09-13 22:23:10 发布

原创最新推荐文章于 2024-09-13 22:23:10 发布 · 381 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #intellij-idea #swagger2

Swagger2是一款帮助程序员快捷创建API接口文档的工具，提高了团队间的沟通效率。本文介绍了Swagger2的集成步骤，包括在pom文件中添加依赖、配置类的编写以及如何测试。通过使用Swagger2的注解，如@Api、@ApiOperation等，可以详细描述接口信息，实现接口管理的便利性。

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

Swagger2介绍
什么是swagger2
编写和维护接口文档是每个程序员的职责，根据Swagger2可以快速帮助我们编写最新的API接口文档，再也不用担心开会前仍忙于整理各种资料了，间接提升了团队开发的沟通效率。

我的理解：一般项目会有很多的api，管理起来很麻烦，可以使用Swagger来管理各种api接口

Swagger集成步骤

1、在pom中添加Swagger2的依赖

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

2、添加配置类Config

/**
 * 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("atguigu", "http://atguigu.com", "493211102@qq.com"))
                .build();
    }

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

3、使用Swagger测试

我的项目使用的端口为8201，
所以访问地址：localhost:8201/swagger-ui.html
在这里插入图片描述
我做的项目是尚硅谷的尚医通项目，API文档更方便管理我们的系统。

常用注解
swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。
@Api：修饰整个类，描述Controller的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiParam：单个参数描述
@ApiModel：用对象来接收参数
@ApiModelProperty：用对象接收参数时，描述对象的一个字段
@ApiImplicitParam：一个请求参数
@ApiImplicitParams：多个请求参数

在这里插入图片描述
在controller类上面加入注解@Api(tags = “医院设置管理”)，在Swagger文档界面会显示医院设置管理，同理注解@ApiOperation