个人中心
gpt4 book ai didi

SpringMVC集成Swagger实例代码

转载 作者：qq735679552 更新时间：2022-09-27 22:32:09 26 4
gpt4 key购买 nike

CFSDN坚持开源创造价值，我们致力于搭建一个资源共享平台，让每一个IT人在这里找到属于你的精彩世界.

这篇CFSDN的博客文章SpringMVC集成Swagger实例代码由作者收集整理，如果你对这篇文章有兴趣，记得点赞哟.

此前写过一个关于SpringBoot集成Swagger的帖子，因为有的项目是SpringMVC的，所以也简单整理了一下，基本一致.

本例使用的是spring 4.1.6版本 。

1、添加POM依赖 。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<!-- Jackson -->
< dependency >
  < groupId >com.fasterxml.jackson.core</ groupId >
  < artifactId >jackson-core</ artifactId >
  < version >2.5.3</ version >
</ dependency >
< dependency >
  < groupId >com.fasterxml.jackson.core</ groupId >
  < artifactId >jackson-annotations</ artifactId >
  < version >2.5.3</ version >
</ dependency >
< dependency >
  < groupId >com.fasterxml.jackson.core</ groupId >
  < artifactId >jackson-databind</ artifactId >
  < version >2.5.3</ version >
</ dependency >
 
<!-- Swagger -->
< 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 >

2、添加SwaggerConfig.java类 。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package com.shanhy.demo.config;
 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
 
import com.google.common.base.Predicate;
 
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
@Configuration // 该注解就是告诉Spring这个是一个配置文件类，这里配置的Bean要交给Spring去管理。这个就是用来取代Beans.xml这种文件的。
@EnableSwagger2 // 启用 Swagger
public class SwaggerConfig {
 
  @Bean
  public Docket createRestApi() {
   Predicate<RequestHandler> predicate = new Predicate<RequestHandler>() {
    @Override
    public boolean apply(RequestHandler input) {
     Class<?> declaringClass = input.declaringClass();
     // if (declaringClass == BasicErrorController.class)// 排除
     // return false;
     if (declaringClass.isAnnotationPresent(RestController. class )) // 被注解的类
      return true ;
     if (input.isAnnotatedWith(ResponseBody. class )) // 被注解的方法
      return true ;
     return false ;
    }
   };
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
     // .genericModelSubstitutes(DeferredResult.class)
     // .genericModelSubstitutes(ResponseEntity.class)
     .useDefaultResponseMessages( false )
     // .forCodeGeneration(false)
     .select().apis(predicate)
     // .paths(PathSelectors.any())//过滤的接口
     .build();
  }
 
  private ApiInfo apiInfo() {
   return new ApiInfoBuilder().title( "接口服务" ) // 大标题
     .version( "1.0" ) // 版本
     .build();
  }
}

3、配置文件添加 。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<? xml version = "1.0" encoding = "UTF-8" ?>
< beans:beans xmlns = "http://www.springframework.org/schema/mvc"
  xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
  xmlns:mvc = "http://www.springframework.org/schema/mvc"
  xmlns:beans = "http://www.springframework.org/schema/beans"
  xmlns:context = "http://www.springframework.org/schema/context"
  xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd
   http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/mvc
    http://www.springframework.org/schema/mvc/spring-mvc.xsd 
   http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
 
 
  <!-- 这里省略了其他原来的配置内容 -->
  ......
  ......
  ......
  ......
 
  < mvc:default-servlet-handler />
 
</ beans:beans >

4、测试Controller方法 。

?
1
2
3
4
5
6
7
8
9
10
11
@Controller
public class HomeController {
 
  @RequestMapping (value = "/test" , method = RequestMethod.GET)
  @ResponseBody
  public String test(Locale locale, Model model) {
 
   return "test" ;
  }
 
}

5、启动服务访问查看效果 。

访问地址：http://localhost:8188/{工程contextPath}/swagger-ui.html 。

SpringMVC集成Swagger实例代码

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我.

原文链接：http://blog.csdn.net/catoop/article/details/58630864 。

最后此篇关于SpringMVC集成Swagger实例代码的文章就讲到这里了,如果你想了解更多关于SpringMVC集成Swagger实例代码的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！ 。

26 4 0
文章推荐： Go语言Telnet回音服务器的实现
文章推荐： Mybatis查询记录条数的实例代码
文章推荐： 详解go语言 make(chan int, 1) 和 make (chan int) 的区别
文章推荐： 关于Spring总结(必看篇)
qq735679552
个人简介

我是一名优秀的程序员,十分优秀！

滴滴打车优惠券免费领取
滴滴打车优惠券
全站热门文章
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com