Swagger整合

Swagger整合

1、导入依赖

            io.springfox
            springfox-swagger2
            2.7.0
        
        
            io.springfox
            springfox-swagger-ui
            2.7.0
         

2、写config配置类

package com.smec.apps.ptms.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.documentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


import java.util.ArrayList;
import java.util.List;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
	@Bean
    public Docket createRestApi() {
        List pars = new ArrayList();
        return new Docket(documentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars)
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("靳大爷的swagger")
                .description("以下是各种方法")
                .termsOfServiceUrl("https://www.cnblogs.com/xiebq/")
                .version("1.0")
                .build();
    }
}

3、创建Controller 进行调试接口

package com.smec.apps.ptms.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.smec.apps.ptms.form.SearchMasterInfo;
import com.smec.apps.ptms.webservice.IPtmsWebService;

import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;


@RestController
@RequestMapping()
public class test {
    @ApiOperation(value = "你好",notes = "", httpMethod = "POST")
    @ApiImplicitParams({
       // @ApiImplicitParam(name = "str" ,value = "字符")
    })
    @RequestMapping("/hello")
    public String hello(@ApiParam("字符") String str){
        return "hello"+str;
    }
    
    @Autowired
    private IPtmsWebService i;
    
    //这里是我要调试的接口
    //导入接口，调用接口方法，传递参数
    @GetMapping("/sa")
    public void sear() {
    	SearchMasterInfo masterInfo = new SearchMasterInfo();
    	masterInfo.setS_No("S0025389_0051");
    	i.searchPartsMaster(masterInfo);
    }
}