springboot集成swagger2

最新推荐文章于 2023-04-20 16:00:03 发布
最新推荐文章于 2023-04-20 16:00:03 发布
阅读量206 收藏
点赞数
分类专栏： Spring 文章标签： springboot swagger2
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq724432055/article/details/78928684
版权

1. 在pom文件中引入以下两个jar包

  
  

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


作者：意识流丶
链接：https://www.jianshu.com/p/d0ca4b0f983d
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
  
  

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


作者：意识流丶
链接：https://www.jianshu.com/p/d0ca4b0f983d
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
  
  

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


作者：意识流丶
链接：https://www.jianshu.com/p/d0ca4b0f983d
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
  
  

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


作者：意识流丶
链接：https://www.jianshu.com/p/d0ca4b0f983d
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
  
  

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


作者：意识流丶
链接：https://www.jianshu.com/p/d0ca4b0f983d
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
  
  

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


作者：意识流丶
链接：https://www.jianshu.com/p/d0ca4b0f983d
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
  
  

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


作者：意识流丶
链接：https://www.jianshu.com/p/d0ca4b0f983d
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
  
  

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


作者：意识流丶
链接：https://www.jianshu.com/p/d0ca4b0f983d
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
  
  

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


作者：意识流丶
链接：https://www.jianshu.com/p/d0ca4b0f983d
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
  
  

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


作者：意识流丶
链接：https://www.jianshu.com/p/d0ca4b0f983d
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
  
  

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


作者：意识流丶
链接：https://www.jianshu.com/p/d0ca4b0f983d
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
<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配置类

@Configuration
@EnableSwagger2
public class Swagger2 extends WebMvcConfigurerAdapter{

    @Bean
     public Docket createRestApi() {
         return new Docket(DocumentationType.SWAGGER_2)
                   .apiInfo(apiInfo())
                   .select()
                   .apis(RequestHandlerSelectors.basePackage("com.fdm.credit.web.controller"))
                   .paths(PathSelectors.any())
                   .build();
     }

     private ApiInfo apiInfo() {
         return new ApiInfoBuilder()
                   .title("Spring Boot中使用Swagger2")
                   .description("Hello Swagger2")
                   .termsOfServiceUrl("http://www.jianshu.com/u/f192766abeab")
                   .version("1.0")
                   .build();
     }

     @Override

     public void addResourceHandlers(ResourceHandlerRegistry registry) {

         registry.addResourceHandler("/**").addResourceLocations("/static","/");

     }

}
3. 下载swagger2压缩包

去官网下载swagger-ui.zip包,解压缩后将dist目录中的所有内容放到项目根目录下的static文件夹中.启动应用输入

localhost:8080/index.html(根据具体情况而定),就可以看到swagger2界面了. 对Controller类进行相关配置,可以参考:

http://blog.csdn.net/saytime/article/details/74937664   

4. 注意的问题

   1) 在我的项目中,为了访问静态资源,还是swagger2类继承了WebMvcConfigurerAdapter,并重写了一个方法,查看api可只其用途.

   2) .apis(RequestHandlerSelectors.basePackage("com.fdm.credit.web.controller"))  要正确配置Controller所在的包

SilentFisher
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
springboot 集成swagger2
菜鸟小扎
01-18 353
一.引入swagger的jar包 <!-- swagger--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</v...
Springboot项目整合Swagger2报错 SpringBoot2.2.6整合swagger2.2.2版本的问题，启动SpringBoot报如下错：
weixin_43623900的博客
07-05 983
*************************** APPLICATION FAILED TO START *************************** Description: Parameter 0 of method linkDiscoverers in org.springframework.hateoas.config.HateoasConfiguration required a single bean, but 15 were found: - modelBuilderPl
SpringBoot集成Swagger构建api文档
热门推荐
都让你们叫老了的博客
01-25 3万+
最近在做项目的时候，一直用一个叫做API的东西，controller注解我会写，这个东西我也会用，但是我确实不知道这个东西是个什么，有点神奇。关键还坑了我一次，他的注解会影响到代码的运行，不光是起到注解的作用。所以我就研究了一下。 Swagger是什么：THE WORLD’S MOST POPULAR API TOOLING 根据官网的介绍： Swagger Inspector：测试AP...
第四章 springboot + swagger
weixin_33910759的博客
08-02 68
注：本文参考自 http://www.jianshu.com/p/0465a2b837d2   swagger用于定义API文档。 好处： 前后端分离开发 API文档非常明确 测试的时候不需要再使用URL输入浏览器的方式来访问Controller 传统的输入URL的测试方式对于post请求的传参比较麻烦（当然，可以使用postman这样的浏览器插件） spring-boot与...
SpringBoot集成SwaggerUi（以及启动时遇到的错误）
在云端
06-08 1692
SpringBoot集成SwaggerUi（以及启动时遇到的错误：No enum constant org.springframework.web.bind.annotation.RequestMethod.Get） SwaggerUi是一个自动生成接口文档，并且还可以去测试这些接口的东西。
SpringBoot集成swagger2
最新发布
m0_37730948的博客
04-20 486
​ 在当今前后端框架流行的时代，一个完整并且规范的接口文档是必不可少的。Swagger是一款Restful接口风格文档在线自动生成、接口功能测试的集成插件，用于生成、描述和可视化Restful风格的Web服务。软件可以实现接口文档同API始终保持同步。同过去的离线接口文档相比起来，整体提高了项目的开发效率，减少了前后端成员之间的非必要沟通。​ 官网地址：https://swagger.io/
SpringBoot集成Swagger2
Oaklkm的博客
07-08 5744
本章节主要介绍SpringBoot项目集成Swagger2的一些相关知识，包括集成版本、依赖、集成方式、以及简单的使用。官方提供的SwaggerUI太low，本篇集成了knife4j，在可视化方面有了大大的提示，操作更加人性化。Swagger是一个restful规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的 工具。在后端服务定义好参数格式以及方法，启动服务后网页即可访问接口信息文档 ，并且在网页端可进行接口测试。Swagger让部署管理和使用功能强大的API变得非常简单。 2.代码配置
SpringBoot 集成 Swagger2
asksl的博客
11-29 789
SpringBoot 集成 Swagger2
Springboot集成Swagger2
蜀道难，难于上青天。
05-06 692
Springboot集成Swagger2 前言 ​ 多年以前写过一篇 springMVC整合swagger(亲自试验完全可用)，但随着springboot的流行，今天记录一下springboot集成swagger2的使用过程，swagger3的集成类似只不过依赖调整了一下，后面会提到。 集成 添加maven依赖 <properties> <swagger.version>2.9.2</swagger.version> </properties> <!
springboot 集成Swagger2
03-04
使用springmvc时通过sprngboot配置swagger2。 RESTful 架构，是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便，所以正得 到越来越多网站的采用。后端通过提供一套标准的RESTful API，...
SpringBoot集成Swagger2生成接口文档的方法示例
08-26
SpringBoot集成Swagger2生成接口文档的方法是开发RESTful API时常用的一种高效手段，它能够自动生成详细的API文档，便于开发者理解和使用。Swagger2是一个强大的工具，它可以与SpringBoot框架无缝结合，提供实时更新...
SpringBoot集成Swagger简单使用
12-22
总结来说，SpringBoot集成Swagger的步骤包括：引入相关依赖，创建Swagger配置类，编写API注解，通过Swagger UI访问和测试API。这个过程使得API的文档化和测试工作变得简单且高效，极大地提高了开发效率和API的可维护...
SpringBoot集成Swagger2实现Restful(类型转换错误解决办法)
08-30
SpringBoot集成Swagger2实现Restful API并解决类型转换错误 标题解析 本文的标题"SpringBoot集成Swagger2实现Restful(类型转换错误解决办法)"，可以拆分为三个部分：SpringBoot、Swagger2、Restful API。其中，...
springboot集成swagger
09-16
总结，SpringBoot集成Swagger2使得我们可以快速、方便地创建和维护API文档，提高了开发效率。通过注解的方式，Swagger2能自动生成接口的详细说明，同时提供交互式的测试环境。掌握这些知识点，将使你的API开发更加...
springboot集成swagger过程解析
08-25
资源摘要信息@Spring Boot集成Swagger过程解析 @Spring Boot集成Swagger是一个非常流行的解决方案，可以帮助开发者快速生成RESTful API文档。下面是@Spring Boot集成Swagger的详细过程解析。 一、添加依赖项 在@...
springboot集成swagger的demo
11-20
SpringBoot集成Swagger是一个高效的方法，用于为API提供交互式文档，极大地简化了接口文档的维护。Swagger是一个强大的工具，它允许开发人员通过简单的注解在代码中定义接口，然后自动生成文档，使得前后端协作更加...
完整SpringBoot集成Swagger项目
11-09
SpringBoot集成Swagger，下载使用开发工具打开即可运行！！！ org.springframework.boot【spring-boot-starter-parent】相关版本2.7.5 io.springfox【springfox-boot-starter】版本3.0.0项目 包含高低两个版本集成...
springboot整合swagger2实例
02-28
本文将深入探讨如何在SpringBoot项目中集成Swagger2，以及如何通过其实例化一个完整的API文档。 1. 安装与配置Swagger2 首先，我们需要在SpringBoot项目中引入Swagger2的相关依赖。在`pom.xml`文件中添加如下Maven...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值