参考地址:https://www.cnblogs.com/exmyth/p/7183753.html

https://blog.csdn.net/programmer_sean/article/details/72236948

1. maven 依赖

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

2. Swagger UI模板 

    下载地址:https://github.com/swagger-api/swagger-ui

swagger-ui-master/dist/index.html

访问配置

<mvc:resources mapping="/swagger/**" location="/swagger/" />

3. swagger 配置文件

@Configuration    // 配置注解,自动在本类上下文加载一些环境变量信息
@EnableWebMvc
@EnableSwagger2   // 使swagger2生效
@ComponentScan(basePackages="com.test.controller") //需要扫描的包路径
public class SpringfoxConfig extends WebMvcConfigurationSupport{@Beanpublic Docket petApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.test.controller")).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("swagger API").description("").termsOfServiceUrl("http://localhost:8080").version("1.0").build();}
}

4. Controller中使用注解添加API文档

@Controller
@RequestMapping("/person")
@Api(tags="个人业务")
public class PersonController {@RequestMapping(value="/getPerson",method= RequestMethod.GET)@ApiOperation(httpMethod = "GET", value = "个人信息", produces = MediaType.APPLICATION_JSON_VALUE)public @ResponseBody Person getPersons() {Person person = new Person();person.setFirstName("fname");person.setLastName("lname");person.setAge(37);person.setDeptName("dept");return person;}
}

5.web.xml配置说明

<servlet><servlet-name>dispatcher</servlet-name><servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class><init-param><param-name>contextConfigLocation</param-name><param-value>classpath*:/spring-mvc.xml</param-value></init-param><load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping><servlet-name>dispatcher</servlet-name><url-pattern>*.do</url-pattern>
</servlet-mapping>
<servlet-mapping><servlet-name>dispatcher</servlet-name><url-pattern>/v2/api-docs</url-pattern>
</servlet-mapping>
说明:Springmvc前端控制器扫描路径增加“/v2/api-docs”,用于扫描Swagger的 /v2/api-docs,否则 /v2/api-docs无法生效。

6. 效果展示

index.html 中修改url:

    <div id="swagger-ui"></div><script src="./swagger-ui-bundle.js"> </script><script src="./swagger-ui-standalone-preset.js"> </script><script>window.onload = function() {// Build a systemconst ui = SwaggerUIBundle({url: "/swaggerDeno/v2/api-docs.json",dom_id: '#swagger-ui',deepLinking: true,presets: [SwaggerUIBundle.presets.apis,SwaggerUIStandalonePreset],plugins: [SwaggerUIBundle.plugins.DownloadUrl],layout: "StandaloneLayout"})window.ui = ui}</script>

转载于:https://www.cnblogs.com/newlangwen/p/9646206.html

springMVC swagger2相关推荐

  1. springmvc+swagger2

    一.swagger2依赖 <!--swagger--> <dependency><groupId>io.springfox</groupId><a ...

  2. 03、Swagger2和Springmvc整合详细记录(爬坑记录)

    时间 内容 备注 2018年6月18日 基本使用 spirngmvc整合swagger2 开始之前这个系列博文基本是,在项目的使用中一些模块的内容记录,但是后期逐渐优化,不单单是整合内容. swagg ...

  3. SpringMVC整合Swagger2

    SpringMVC整合Swagger2 前言 POM引入 Swagger配置类 spring-mvc.xml设置 如果有在web.xml里配置拦截器 测试类 准备就绪 注意事项 爬坑经历 参考文章 前 ...

  4. dubbo2.5-spring4-mybastis3.2-springmvc4-mongodb3.4-redis3(十)之Spring MVC中使用 Swagger2 构建Restful API...

    版权声明:本文为博主原创文章,未经博主允许不得转载. https://blog.csdn.net/u010046908/article/details/55047193 1.Swagger2是什么? ...

  5. 基于Spring+SpringMVC+Mybatis的分布式敏捷开发系统架构(附源码)

    点击上方 好好学java ,选择 星标 公众号重磅资讯,干货,第一时间送达 今日推荐:推荐19个github超牛逼项目!个人原创100W +访问量博客:点击前往,查看更多 作者:zheng gitee ...

  6. SpringBoot 使用Swagger2打造在线接口文档(附源代码)

    点击上方"好好学java",选择"置顶公众号" 优秀学习资源.干货第一时间送达! 精彩内容 java实战练习项目教程 2018微服务资源springboot.s ...

  7. SSM三大框架整合Springfox(Swagger2)详细解决方案

    由于项目中使用的是前后端分离,所以,频繁的需要进行数据的交互和接口的调用,所以需要api文档的使用,这样就更加的方便,于是就找到了swagger这个东东,还是很好用.下面介绍一下如何整合到spring ...

  8. Swagger UI 与SpringMVC的整合 II

    pom.xml <!-- swagger开始 --><dependency><groupId>io.springfox</groupId><art ...

  9. SpringMVC+JWT+Swagger UI+RestFul

    前言: 其实很早就想写这篇文章了,因为我觉得这会对很多新手有指引作用,当初自己也是瞎子过河的摸索着过来的.目前后台开发比较流行的MVC框架中使用Spring MVC还是比较多的,当然还有Spring ...

最新文章

  1. AlexNet 网络详解及Tensorflow实现源码
  2. 有了这几个神器,瞬间逼格就上去了
  3. DataBase project physical design
  4. Spring Cloud Feign设计原理
  5. 阿里影业授出1672.5万份购股权
  6. winform 填充圆形 锯齿_Qt项目中,三种图形渐变填充方式详细总结
  7. Oracle NID工具修改数据库DBID和数据库名称
  8. urlencode编码问题(以及urlparse)
  9. createwindow 和 dialogbox的区别
  10. 仿layui风格漂亮easyui主题皮肤美化
  11. 捷径app 未能连接到服务器,iOS13快捷指令无法添加第三方捷径的解决办法
  12. python日期计算,Python 日期的转换及计算的具体使用详解
  13. BZOJ3505 CQOI2014数三角形(组合数学)
  14. 如何实现数据库的读写分离
  15. FastDFS构成、特性、Linux下安装以及Java如何访问
  16. SPI实现SST25VF016B驱动(Flash)
  17. ERROR Plumber found unhandled error: Error in plugin gulp-htmlmin
  18. 名企笔试真题精选 (四)
  19. 培训机构出来的程序员目前的就业前景怎么样?
  20. 物联网毕设 -- 智能厨房检测系统

热门文章

  1. 项目管理和缺陷跟踪工具Redmine
  2. Platform Builder 5下WinCE 5.0目录结构
  3. nginx和squid配合搭建的web服务器前端系统
  4. C语言的32个关键字
  5. ASP.NET中利用cookies保持客户端信息
  6. 使用 ASP+ DataGrid 控件来创建主视图/详细资料视图
  7. 在Windows7/10上快速搭建深度学习框架Caffe开发环境
  8. 【视频】对RTSP抓包,分析通讯流程
  9. 写注册机犯法吗_逼着一个受害者去向另一个受害者道歉,不过分吗?
  10. python 区域和检索_304. 二维区域和检索(Python)