Swagger整合

最新推荐文章于 2024-08-17 12:33:42 发布

拥有人鱼线的娃娃鱼

最新推荐文章于 2024-08-17 12:33:42 发布

阅读量212

点赞数 2

文章标签： java spring

本文链接：https://blog.csdn.net/qq_43857092/article/details/122447263

版权

1、导入依赖

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

2、写config配置类

/**  
 * @Title:  Swagger.java   
 * @Package com.smec.apps.ptms.config   
 * @Description:    描述   
 * @author: MY     
 * @date:   2022年1月11日 下午3:43:48   
 * @Copyright: 
 */
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;
/**   
 * @ClassName:  Swagger   
 * @Description:TODO(描述这个类的作用)   
 * @author: MY
 * @date:   2022年1月11日 下午3:43:48      
 * @Copyright:  
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
	@Bean
    public Docket createRestApi() {
        List<Parameter> pars = new ArrayList<Parameter>();
        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 进行调试接口

/**  
 * @Title:  test.java   
 * @Package com.smec.apps.ptms.controller   
 * @Description:    描述   
 * @author: MY     
 * @date:   2022年1月12日 上午9:27:54   
 * @Copyright: 
 */
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;

/**   
 * @ClassName:  test   
 * @Description:TODO(描述这个类的作用)   
 * @author: MY
 * @date:   2022年1月12日 上午9:27:54      
 * @Copyright:  
 */
@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);
    }
}