Skip to content

Commit 563f663

Browse files
committed
SpringBoot Scala Swagger使用
1 parent 2c0ef67 commit 563f663

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

SpringBoot-Swagger/README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -77,24 +77,24 @@ class UserController @Autowired()(private val userService : UserService){
7777
* @ApiImplicitParams:用在方法上包含一组参数说明
7878
* @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
7979

80-
paramType:参数放在哪个地方
81-
header-->请求参数的获取:@RequestHeader
82-
query-->请求参数的获取:@RequestParam
83-
path(用于restful接口)-->请求参数的获取:@PathVariable
84-
body(不常用)
85-
form(不常用)
86-
name:参数名
87-
dataType:参数类型
88-
required:参数是否必须传
89-
value:参数的意思
90-
defaultValue:参数的默认值
80+
- paramType:参数放在哪个地方
81+
- header-->请求参数的获取:@RequestHeader
82+
- query-->请求参数的获取:@RequestParam
83+
- path(用于restful接口)-->请求参数的获取:@PathVariable
84+
- body(不常用)
85+
- form(不常用)
86+
- name:参数名
87+
- dataType:参数类型
88+
- required:参数是否必须传
89+
- value:参数的意思
90+
- defaultValue:参数的默认值
9191

9292
* @ApiResponses:用于表示一组响应
9393
* @ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
9494

95-
code:数字,例如400
96-
message:信息,例如"请求参数没填好"
97-
response:抛出异常的类
95+
- code:数字,例如400
96+
- message:信息,例如"请求参数没填好"
97+
- response:抛出异常的类
9898

9999
* @ApiModel:描述一个Model的信息(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)
100100
* @ApiModelProperty:描述一个model的属性

0 commit comments

Comments
 (0)