`
zhaijizhe
  • 浏览: 1756 次
  • 性别: Icon_minigender_1
  • 来自: 西安
最近访客 更多访客>>
社区版块
存档分类
最新评论

springmvc+swagger整合

 
阅读更多
1、引入maven依赖
<dependency>   
    <groupId>com.mangofactory</groupId>   
    <artifactId>swagger-springmvc</artifactId>   
    <version>1.0.2</version>   
</dependency> 
<dependency> 
    <groupId>com.fasterxml.jackson.core</groupId> 
    <artifactId>jackson-core</artifactId> 
    <version>2.5.1</version> 
</dependency> 
<dependency> 
    <groupId>com.fasterxml.jackson.core</groupId> 
    <artifactId>jackson-databind</artifactId> 
    <version>2.5.1</version> 
</dependency> 
<dependency> 
    <groupId>com.fasterxml.jackson.core</groupId> 
    <artifactId>jackson-annotations</artifactId> 
    <version>2.5.1</version> 
</dependency>
2、创建自定义swagger初始化配置文件
@EnableSwagger 
@ComponentScan(basePackages={"org.giles.springmvc.controller"})
public class SwaggerConfig {
private SpringSwaggerConfig springSwaggerConfig; 
    @Autowired 
    public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig) 
    { 
        this.springSwaggerConfig = springSwaggerConfig; 
    } 
    @Bean 
    public SwaggerSpringMvcPlugin customImplementation() 
    { 
        return new SwaggerSpringMvcPlugin(this.springSwaggerConfig) 
                .apiInfo(apiInfo()) 
                .includePatterns(".*?"); 
    } 
 
    private ApiInfo apiInfo() 
    { 
        ApiInfo apiInfo = new ApiInfo( 
                "springmvc搭建swagger", 
                "spring-API swagger测试", 
                "My Apps API terms of service", 
                "534560449@qq.com", 
                "web app", 
                "My Apps API License URL"); 
        return apiInfo; 
    } 
}
3、将swagger配置类及依赖SpringSwaggerConfig加载到spring容器中
<mvc:annotation-driven></mvc:annotation-driven>
<!-- 将 springSwaggerConfig加载到spring容器 -->
<bean class="com.mangofactory.swagger.configuration.SpringSwaggerConfig" />
<!-- 将自定义的swagger配置类加载到spring容器 -->
<bean class="org.giles.springmvc.config.SwaggerConfig"></bean>
<!-- 静态资源文件,不会被Spring MVC拦截 -->
<mvc:resources
mapping="/swagger/**" location="/WEB-INF/swagger/" />
4、配置相关controller的api
@Api(value="user") 
@Controller 
@RequestMapping(value="/user") 
public class UserController {
private static Logger logger=Logger.getLogger(UserController.class);
@RequestMapping(value = "/getUser/{userId}",method=RequestMethod.GET) 
    @ResponseBody 
@ApiOperation(value=Constant.GETUSERINFOBYUSERID,httpMethod="GET",notes=Constant.GETUSERINFOBYUSERID,response=ModelAndView.class) 
    public ModelAndView getUser(@ApiParam(required=true,value="用户ID",name="userId")@PathVariable("userId")Integer userId) { 
ModelAndView modelAndView=new ModelAndView();
logger.info("用户id:"+userId+"+++++++++++++++++");
modelAndView.setViewName("userDetail");
return modelAndView;   

}
5、和swagger UI的集成
在GitHub上将swaggerui下载,地址:https://github.com/swagger-api/swagger-ui。解压后将dist文件夹中所有的文件拷贝到webapp/swagger这里的swagger是作者自定义的你可以写为自己创建的目录。
修改index.html中的 http://petstore.swagger.wordnik.com/v2/swagger.json修改为自己项目路径+api-docs
在浏览器中输入:http://localhost:8080/springmvc/swagger/dist/index.html


  • 大小: 78.8 KB
分享到:
评论

相关推荐

    java springMVC+swagger dome

    SpringMVC和Swagger是Java开发Web应用中两个重要的组件,它们在实际项目中有着广泛的应用。...这个"SwaggerDome"示例可以帮助初学者快速理解和掌握SpringMVC与Swagger的整合,为实际项目开发打下坚实的基础。

    SpringMVC+fastjson+Swagger集成示例源码

    在IT行业中,SpringMVC、Fastjson和Swagger是三个非常重要的技术组件,它们分别用于构建Web应用程序、数据序列化和API文档化。本示例源码整合了这三个工具,为开发者提供了一个高效、易用的开发环境。让我们深入探讨...

    springmvc+swaggerz整合项目.zip

    《Spring MVC与Swagger2深度整合指南》 在现代Web开发中,Spring MVC作为Java领域最常用的MVC框架,为开发者提供了强大的后端控制层支持。而Swagger2则是一款优秀的API文档自动化生成工具,能帮助开发者方便地管理...

    springmvc与swagger整合使用的包 普通web项目的jar工程包

    在IT行业中,SpringMVC和Swagger的整合是一个常见的需求,特别是在构建RESTful API服务时,为了提供清晰的接口文档和方便的API测试。SpringMVC是Spring框架的一部分,用于处理HTTP请求,而Swagger则是一个强大的工具...

    SpringMVC 集成 Swagger2

    本文将详细介绍如何在SpringMVC项目中集成Swagger2,以实现API的自动化文档生成。 首先,我们需要了解Swagger2的核心组件。Swagger2的核心是`@Api`和`@ApiOperation`注解,它们用于标记API接口和方法,以便Swagger...

    ssm+maven+swagger框架整合

    spring4.0.2+springmvc4+mybatis3.2.6+swagger2.40+java1.8+maven框架的整合简单例子,其中还有一些工具类下载下来直接用eclipse 导入项目会自动加载jar,检查jdk对应版本,直接启动tomcat,如果有监听类异常请(右键...

    Springboot + SpringMvc + mybatis 整合Demo

    **SpringBoot + SpringMVC + Mybatis 整合详解** SpringBoot、SpringMVC和Mybatis是Java领域中非常流行的三大框架,它们分别在不同层面为开发者提供了强大的支持。SpringBoot简化了Spring应用的初始搭建以及开发...

    eclipse下的spring+springmvc+mybatis整合

    在IT行业中,Spring、SpringMVC和MyBatis是三个非常重要的开源框架,它们的整合是Java企业级应用开发中的常见实践。这个整合通常被称为"SSM"框架,即Spring、SpringMVC和MyBatis的缩写。下面将详细阐述这三者的基本...

    SpringMVC和Swagger整合方法

    SpringMVC和Swagger整合方法 SpringMVC是一种基于Java的Web应用程序框架,用于构建Web应用程序,而Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。本文将为大家介绍SpringMVC...

    Java+SpringMvc+mybatis+RestAPI,整合swagger

    Java SpringMvc Mybatis RestAPI与Swagger的整合是一个常见的实践,用于构建现代Web服务。这个架构组合提供了强大的功能,包括后端开发的灵活性、数据访问的高效性以及前端友好的API接口。Swagger则作为文档和测试...

    Spring+SpringMVC+Mybatis整合实现增删改查功能(适合入门学习也可以做脚手架开发)

    1.SpringMVC4.3.16,Mybatis3.2.2,Spring4.3.16三大框架的整合; 2、项目基于Maven做依赖管理 3、前端框架集成了Bootstrap3.3.5,Jquery1.12.3,集成了Bootstrap插件Bootgrid数据表格实现分页,使用Bootstrap的...

    采用Spring+SpringMVC+Mybatis整合实现增删改查功能(适合入门学习也可以做脚手架开发)

    1.SpringMVC4.3.16,Mybatis3.2.2,Spring4.3.16三大框架的整合; 2、项目基于Maven做依赖管理 3、前端框架集成了Bootstrap3.3.5,Jquery1.12.3,集成了Bootstrap插件Bootgrid数据表格实现分页,使用Bootstrap的...

    springMvc+Mybatis+maven整合

    在IT行业中,Spring MVC、Spring和MyBatis是三个非常重要的框架,它们分别负责Web层、业务层和服务...在实际项目中,还可以根据需要引入其他组件,如Spring Security进行权限控制,或者使用Swagger进行API文档的生成。

    SpringMvc-SwaggerDemo

    标签“SprinSwagger”进一步确认了这个项目的核心是关于Spring和Swagger的整合。这通常意味着开发者可以期待在这个项目中看到如何配置Spring MVC以支持Swagger,以及如何定义和展示API文档。 由于提供的文件列表...

    ssm+maven+swagger+上传功能+框架整合

    SSM(Spring、SpringMVC、MyBatis)框架整合是Java Web开发中常见的技术栈,主要用于构建基于Java的企业级应用程序。在这个项目中,我们看到SSM与Maven的结合,以及Swagger的引入,用于增强API文档的生成和管理。...

    springmvc整合swagger所需jar包

    4. `swagger-springmvc`或`springfox-swagger2`(如果是较新版本):提供了与Spring MVC的集成,能够自动扫描并解析Spring MVC的注解来生成Swagger的API定义。 整合步骤通常包括: 1. 添加依赖:在项目的`pom.xml`...

    idea 搭建springboot 集成mybatis+springmvc

    在本文中,我们将深入探讨如何使用IntelliJ IDEA(Idea)搭建一个Spring Boot项目,...在实际开发过程中,可以根据项目需求进一步优化配置,例如添加Swagger2实现API文档,或者使用Thymeleaf或Freemarker进行视图渲染。

    Spring+SpringMVC+Mybatis(开发必备技能)03、swagger配套编码,完整版本

    通过学习和实践这个课程,开发者可以掌握SSM框架的使用,了解如何整合Swagger2进行API接口的管理和测试,从而提升开发效率和代码质量。这对于从事后端开发、特别是需要构建RESTful API服务的开发者来说,是一项非常...

    springboot+shiro+websocket+swagger

    标题"springboot+shiro+websocket+swagger"表明这是一个关于将这四个技术整合到一起的应用示例或教程。下面我们将逐一深入探讨这些技术以及它们的整合方式。 首先,SpringBoot是基于Spring的轻量级框架,它引入了...

    SpringMvc整合swagger2 .docx下载

    ### Spring MVC 整合 Swagger2 实现在线 API 文档测试 在现代软件开发过程中,API 文档对于提高团队协作效率、降低系统维护成本至关重要。Swagger 是一个非常流行的框架,能够帮助开发者快速创建、记录和使用 ...

Global site tag (gtag.js) - Google Analytics