卜若的代码笔记系列-Web系列-SpringBoot-第十二章：Swagger的批注详解-3212

1.

@ApiOperation("swaggerTest")

用来描述当前的api的简略信息

我来解释下为什么会出现这么多比如DELETE,GET,HEAED啥的请求，因为swagger默认将所有请求全部显示出来，为了解决这种情况，我们其实可以将这个api单独定义为post或者get：

这样，我们在swagger的网页里面就能看到这样的效果

2.

@ApiImplicitParam(name = "id", value = "ID", required = true, dataType = "Long",paramType = "query")

用来在swagger的网页里面显示api的输入，主要目的在于api的测试，下面的@ApiParam用法也差不多 

 

name:参数名

value:描述

required:是否必须填，也就是说，= true的时候，你必须填这个数据才能向你的服务器提交

dataType：数据类型

paramType：参数类型
这个有五个选项
path, query, body, header, form

除了query可以正常的传递String，float，之类的，其他的我就不是很清楚

 3.  多个参数

@ApiImplicitParams({
@ApiImplicitParam(name = "userName",value = "用户名",required = true,dataType = "String",paramType="query"),
@ApiImplicitParam(name = "password",value = "密码",required = true,dataType = "String",paramType="query")
})

可以通过这种方法发射多个参数，然后通过@RequestParam dataType name获得参数

4. 

@ApiParam(required=true,value="封面图片")

swagger里面用来声明该参数为输入参数。

举个例子

	@PostMapping("/swaggerTest")
	public void swaggerTest(
			@ApiParam(required = true,value = "@ApiParam测试" )
			@RequestParam float userName
	)
	{
		System.out.print(userName);
	
	}

 

原创博客，转载请标明引用