Swagger在项目中的使用

最新推荐文章于 2025-02-15 19:03:06 发布

康康要加油

最新推荐文章于 2025-02-15 19:03:06 发布

阅读量672

点赞数

文章标签： swagger 接口

本文链接：https://blog.csdn.net/kangkang12221222/article/details/124543899

版权

本文介绍了Swagger在项目中的应用，包括其作为接口文档工具的作用，如何在SpringBoot项目中整合Swagger2和Swagger UI，以及Swagger提供的注解详细说明，如@Api、@ApiOperation等，用于接口的文档注释和忽略。同时提到了Swagger-ui插件的安装和文档访问方法。

摘要由CSDN通过智能技术生成

一、Swagger简介

swagger是一个用于生成服务器接口的规范性文档、并且能够对接口进行测试的工具。

1、作用：

生成接口说明文档

接口进行测试

2、整合:

在api子工程添加依赖（Swqgger2 \ Swagger UI）

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

在api子工程中创建swagger的配置（java配置方式）

@Configuration
@EnableSwagger2
public class SwaggerConfig {
   

    /*swagger会帮助我们生成接口文档
    * 1：配置生成的文档信息
    * 2：配置生成规则*/

    /*Docket封装接口文档信息*/
    @Bean
    public