SwaggerUI自动生成API文档(SwaggerUI+SpringBoot)

1.Swagger介绍

百度百科：Swagger的目标是为REST APIs 定义一个标准的，与语言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。当服务通过Swagger定义，消费者就能与远程的服务互动通过少量的实现逻辑。类似于低级编程接口，Swagger去掉了调用服务时的很多猜测。

我觉得把Swagger当成一种开发工具就好，省去了手写文档的步骤，生成文档并能测试，注解的方式让其他人看代码也更加清楚方便。

想了解更多有关资料点击： Swagger官网

浏览 Swagger-Spec去了解更多关于Swagger 项目的信息，包括附加的支持其他语言的库。

2.搭建

引入相关依赖

<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger2artifactId>
    <version>2.2.2version>
dependency>
<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger-uiartifactId>
    <version>2.2.2version>
 dependency>

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11

修改启动代码

@SpringBootApplication
@Configuration
@EnableSwagger2
public class Application extends SpringBootServletInitializer {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    /**
     * 以下是使用swagger2 生成api文档
     *
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.test.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 构建 api文档的详细信息函数
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("标题")
                //描述
                .description("描述")
                .termsOfServiceUrl("http://localhost:8080/swagger-ui.html")
                //创建人
                .contact("api")
                //版本
                .version("1.0")
                .build();
    }
}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39
• 40
• 41
• 42
• 43
• 44

搭建好之后可以启动项目可以打开浏览器，访问http://localhost:8080/swagger-ui.html 即可看到文档界面

3.相关使用

简单的一个例子

package com.dxyl.explame;

import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author Huangqing
 * @date 2018/5/17 10:20
 */
@RestController
@RequestMapping("/swagger")
public class SwaggerController {

    @ApiOperation(value = "你好Swagger", notes = "测试使用")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "name", value = "姓名", dataType = "String", paramType = "query", required = true),
            @ApiImplicitParam(name = "age", value = "年龄", dataType = "int", paramType = "query", required = false)
    })
    @PostMapping("/hello")
    public String hello(@RequestParam(value = "name", required = false) String name, @RequestParam(value = "age", required = false) int age) {
        return String.format("Hello Swagger！name:%s,age:%s", name, age);
    }

/**
	 * 

	 * Discription:[文件上传，返回文件链接地址]
	 */
	@ApiOperation(value = "文件上传，返回文件链接地址[[email protected]]")
	@PostMapping(value = "/upload", consumes = { "multipart/*" }, headers = "content-type=multipart/form-data")
	public JSONObject upload(@ApiParam(value = "文件", required = true) @RequestParam() MultipartFile file,
			@ApiParam(value = "语言类型", required = true) @RequestHeader(required = false, defaultValue = "ch") String language)
			throws IOException {
		if (file == null) {
			return ApiResponse.jsonData(APIStatus.ERROR_400, language);
		}
		String name = file.getOriginalFilename();
		if (!fileSuffixUtils.isPermit(name)) {
			return ApiResponse.jsonData(APIStatus.ERROR_312,language);
		}
		if (name == null) {
			return ApiResponse.jsonData(APIStatus.ERROR_400, language);
		}
		String url = giftService.upload(file.getBytes(), file.getOriginalFilename());
		return ApiResponse.jsonData(APIStatus.OK_200, url);
	}

}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
•   28    

测试结果

Swagger注解

Api	作用范围	使用位置
@ApiModelProperty	对象属性	用在出入参数对象的字段上
@Api	协议集描述	用于controller类上
@ApiOperation	协议描述	用在controller的方法上
@ApiResponses	Response集	用在controller的方法上
@ApiResponse	Response	用在 @ApiResponses里边
@ApiImplicitParams	非对象参数集	用在controller的方法上
@ApiImplicitParam	非对象参数描述	用在@ApiImplicitParams的方法里边
@ApiModel	描述返回对象的意义	用在返回对象类上

@ApiImplicitParam中的属性详情

属性	取值	使用位置
paramType	-	查询参数类型
-	path	以地址的形式提交数据
-	query	直接跟参数完成自动映射赋值
-	body	以流的形式提交 仅支持POST
-	header	参数在request headers 里边提交
-	form	以form表单的形式提交 仅支持POST
dataType	-	参数的数据类型 只作为标志说明，并没有实际验证
-	Long	-
-	String	-
-	int	-
-	Object	-
name	-	接收参数名(非参数描述)
value	-	接收参数的意义描述
required	-	参数是否必填
-	true	必填
-	false	非必填
defaultValue		默认值

4.查看API文档地址

http://localhost:8080/项目名/swagger-ui.html