SpringMVC与Swagger2集成文档.pdf

精品课程 千锋教育 全程面授 SpringMVC 与 Swagger2 集成文档 By ：千锋西安教学部 Disen 一、 Springfox-Swagger/Swagger2 说明 Swagger 是一系列对 RESTful 接口进行规范描述和页面展示的工具， 通过 springfox-swagger 将 Swagger 与 Spring-MVC 整合, 可从代码中 的注解获取信息, 并生成相应的文档. 效果如下所示. 图 1.1 swagger –ui 效果图 目前 Swagger 的 api 版本规范已经更新到 3.0 版本，考虑 SpringMVC 的版本， 本方案集成 2.0 版本。另外，Swagger 的数据格式采用了JSON 和 YAML ， 详情请参考官方文档 https://swagger.io/docs/。 二、SpringMVC 项目中集成 Springfox-Swagger 集成的前提，当前的项目已具备了 SpringMVC 或 Restfull 开发能力， 同时支持返回 ResponseBody 的数据类型为json 。 1. Maven 的 pom.xml 中添加依赖 做真实的自己-用良心做教育 精品课程 千锋教育 全程面授 !--引入 swagger2 springmvc 快速生成 API 文档包 -- dependency groupIdio.springfox/groupId artifactIdspringfox-swagger2/artifactId version2.4.0/version scopecompile /scope /dependency !-- 支持 swaager2-ui 图形化显示 -- dependency groupIdio.springfox/groupId artifactId springfox-swagger-ui/artifactId version 2.4.0/version /dependency 2. 自定义Swagger 配置类 －AppSwaagerConfig package com.qfxa.swagger; import java.util.ArrayList; import java.util.List; 做真实的自己-用良心做教育 精品课程 千锋教育 全程面授 import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.web.servlet.config.annotation.EnableWebMvc; import springfox.