Advertisement

ssm集成Swagger详细步骤操作

阅读量:

ssm框架:spring、springmvc、mybatis

第一步 :引用依赖

复制代码
      <!--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>

第二步:新建 SwaggerConfig.java 类

复制代码
 package com.xufengtech.ticket.util;

    
  
    
 import org.springframework.context.annotation.Bean;
    
 import org.springframework.context.annotation.ComponentScan;
    
 import org.springframework.context.annotation.Configuration;
    
 import org.springframework.web.servlet.config.annotation.EnableWebMvc;
    
  
    
 import springfox.documentation.spi.DocumentationType;
    
 import springfox.documentation.spring.web.plugins.Docket;
    
 import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
 import springfox.documentation.builders.ApiInfoBuilder;
    
 import springfox.documentation.builders.RequestHandlerSelectors;
    
 import springfox.documentation.service.ApiInfo;
    
  
    
 @Configuration //声明该类为配置类
    
 @EnableSwagger2 //声明启动Swagger2
    
 @EnableWebMvc //声明启动mvc
    
 public class SwaggerConfig{
    
     @Bean
    
     public Docket customDocket() {
    
     return new Docket(DocumentationType.SWAGGER_2)
    
             .apiInfo(apiInfo())
    
             .select()
    
             .apis(RequestHandlerSelectors.basePackage(""))//扫描的包路径
    
             .build();
    
     }
    
  
    
     private ApiInfo apiInfo() {
    
     return new ApiInfoBuilder()
    
             .title(" ticket API接口")//文档说明
    
             .version("1.1.0")//文档版本说明
    
             .build();
    
     }
    
 }

第三步:在spring-mvc.xml 配置

复制代码
  <!-- swagger -->

    
 	<bean
    
 		class="springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration"
    
 		id="swagger2Config" />
    
 	<mvc:resources location="classpath:/META-INF/resources/"
    
 		mapping="swagger-ui.html" />
    
 	<mvc:resources location="classpath:/META-INF/resources/webjars/"
    
 		mapping="/webjars/**" />
    
  
    
 </beans>

第三步 :编写接口com.xufengtech.ticket.controller

第四步:重启服务器 运行项目 打开浏览器 地址栏输入: http://(IP):(端口)/项目名/swagger-ui.html

http://localhost:8080/ticket/swagger-ui.html 如下

选择黄色区域 可以看到你写的controller类里面的接口

全部评论 (0)

还没有任何评论哟~