swagger SpringBoot整合使用swagger2

Swagger2

在项目开发中,前后端都是通过接口文档进行沟通,而一个好的接口文档可以减少很多成本,但是在开发过程中,接口文档总是会出现各种的变化,例如,开始设计的文档不合理,或者甲方需求变更等,接口文档有变化就需要进行维护,而维护起来比较麻烦,很容易造成文档与代码不一致,所以我们可以使用swagger来让我们接口更规范,以及方标维护。

swagger是一个Redtful接口的文档自动生成,以及测试的软件(可以自动生成RestFul的接口文档以及对接口进行测试)

  1. 引入依赖

    <!--Swagger2 依赖-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
    
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-spring-web</artifactId>
        <version>2.9.2</version>
    </dependency>
    
  2. 编写Swagger2的配置类

    @SpringBootConfiguration
    @EnableSwagger2  // 开启swagger注解的使用
    public class SpringSwagger2 {
         
        @Bean
        public Docket createRestApi()
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger是一款用于构建、文档化和测试API的开源框架。它提供了一组工具和约定,可以轻松地生成API文档,并通过交互式UI提供对API的可视化展示和测试。在Spring Boot项目中,可以使用Swagger整合和管理API文档。 对于Spring Boot整合Swagger的具体步骤,可以根据使用Swagger版本有所不同。下面我将分别介绍Swagger2和Swagger3的整合步骤。 1. Swagger2与Spring Boot整合的步骤: - 在项目的pom.xml文件中添加Swagger2的Maven依赖。 - 创建一个配置类Swagger2Config.java,用于配置Swagger2的相关参数和扫描的API接口。 - 编写API接口,并使用Swagger2的注解来定义接口的文档信息。 - 启动Spring Boot应用,访问Swagger页面即可查看生成的API文档。 2. Swagger3与Spring Boot整合的步骤: - 在项目的pom.xml文件中添加Swagger3的Maven依赖。 - 在启动类上添加@EnableOpenApi注解,开启Swagger3的自动配置。 - 创建一个配置类Swagger3Config.java,用于配置Swagger3的相关参数和扫描的API接口。 - 编写API接口,并使用Swagger3的注解来定义接口的文档信息。 - 启动Spring Boot应用,访问Swagger页面即可查看生成的API文档。 需要注意的是,具体的Maven依赖和配置类的代码可能会因为使用Swagger版本不同而有所变化。因此,在实际操作中,可以根据项目的需求和使用Swagger版本来进行相应的调整和配置。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *3* [springboot整合Swagger](https://blog.csdn.net/qq_34972876/article/details/117693710)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *2* [SpringBoot整合Swagger2实例方法](https://download.csdn.net/download/weixin_38651661/12748551)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值