三步实现接口可视化swagger

最新推荐文章于 2024-07-31 21:10:31 发布

liutaochn

最新推荐文章于 2024-07-31 21:10:31 发布

阅读量1.1k

点赞数

分类专栏： JAVA SE JAVAEE 文章标签： swagger 接口测试接口文档

本文链接：https://blog.csdn.net/liutaochn/article/details/78030463

版权

JAVAEE 同时被 2 个专栏收录

2 篇文章 0 订阅

订阅专栏

JAVA SE

1 篇文章 0 订阅

订阅专栏

1，pom文件种配置

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

2，创建处理类Swagger2

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

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

@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.uway.mobile.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("移动态势感知数据接口API")
                .description("")
                .termsOfServiceUrl("http://www.uway.cn")
                .contact("武汉研发中心")
                .version("1.0")
                .build();
    }

}

3，在接口上增加注释

@ApiOperation(value = "导入excel文件", notes = "手工导入数据到数据库")
	@ApiImplicitParam(name = "file", value = "导入文件", required = true, dataType = "MultipartFile")
	@RequestMapping(value = "/uploadFile", method = RequestMethod.POST)
	public Result addAppCheck(HttpServletRequest request,
			@RequestParam(value = "exFile", required = true) MultipartFile file) throws Exception {

访问 http://项目路径/swagger-ui.html

参考
http://www.jianshu.com/p/8033ef83a8ed

http://www.jianshu.com/p/12f4394462d5