集成swagger

一:依赖

二:配置

三:代码

注解说明:

@APi:用在请求的类上,表示对类的说明 tags="说明该类的作用,可以在UI界面上看到的注解",value="该参数没什么意义,在UI界面上也看到,所以不需要配置"

@ApiOperation:用在请求的方法上,说明方法的用途、作用

value="说明方法的用途,作用" 

notes="方法的备注说明"

@ApiOperation(value = "查询demo1", notes = "查询demo1")

@ApiImplicitParams:用在请求的方法上,表示一组参数说明

@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面

name:参数名

value:参数的汉字说明、解释 

required:参数是否必须传

paramType:参数放在哪个地方

      header --> 请求参数的获取:@RequestHeader

      query --> 请求参数的获取:@RequestParam

       path(用于restful接口)--> 请求参数的获取:@PathVariable

       body(不常用)

       form(不常用)

dataType:参数类型,默认String,其它值dataType="Integer"

defaultValue:参数的默认值

@ApiImplicitParams({ @ApiImplicitParam(paramType = "query", name = "param1", value = "字符串参数", dataType = "String"),@ApiImplicitParam(paramType = "query", name = "param2", value = "整形参数", dataType = "Integer") })

猜你喜欢

转载自blog.csdn.net/qq_33835009/article/details/85062416
今日推荐