1. 程式人生 > >一分鐘 SSM框架整合 swagger

一分鐘 SSM框架整合 swagger

swagger:超好用的介面API工具,對於後臺來說不需要專門寫測試頁面就可以對介面進行除錯。

接下來,給我一分鐘!來完成spring+springmvc+mybaties框架上整合swagger。

第一步:maven引入所需jar包

        <!-- swagger -->
        <dependency>
            <groupId>com.mangofactory</groupId>
            <artifactId>swagger-springmvc</artifactId>
            <version>1.0.2</version>
        </dependency>
        <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>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
             <version>2.7.5</version>
       </dependency>

第二步:自定義相關配置

package com.test.document;


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;


import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration
@EnableSwagger2 //Loads the spring beans required by the framework
public class MySwaggerConfig {


    @Bean
    public Docket userApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()  // 選擇那些路徑和api會生成document
                .apis(RequestHandlerSelectors.any()) // 對所有api進行監控
                .paths(PathSelectors.any()) // 對所有路徑進行監�?
                .build();
    }
    @Bean
    public RequestMappingInfoHandlerMapping requestMapping(){
        return new RequestMappingHandlerMapping();
    }
}

第三步:在applicationContext.xml檔案進行配置

    <!-- 引入swagger相關 -->
    <bean class="com.test.document.MySwaggerConfig"/>
    <mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/" />
    <mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/" />

第四步:在springMVC配置檔案中引入swagger相關配置包

<bean class="springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration" id="swagger2Config"/>

第五步:在controller層配置controller及方法

package com.test.controller;


import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;


import com.wordnik.swagger.annotations.ApiOperation;


import io.swagger.annotations.Api;


@Controller
@RequestMapping(value="/TestExcelFast")
@Api(value = "restful", description = "測試")
public class TestExcelFastController {

@ApiOperation(value = "測試專用")
@RequestMapping(value="/test",method=RequestMethod.GET)
@ResponseBody
public String  test(){
String str = "123";
System.out.println(1);
return str;
}


}

第六步:配置已經完畢,啟動專案,輸入訪問地址

http://localhost:8080/專案名稱/swagger-ui.html


執行!try


輸出結果:


   到此為止!

  swagger已經整合完畢!