Skip to content

Commit 51541ae

Browse files
authored
Update swagger-usage-guideline.md
1 parent 49863bd commit 51541ae

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

backend/swagger-usage-guideline.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@
3434

3535
## 请求参数说明
3636

37-
- 参数若为类对象:
37+
- 参数若为类对象:
3838

39-
- 类名上需加如下注释,用于说明此对象参数的名称:
39+
- 类名上需加如下注释,用于说明此对象参数的名称:
4040

4141
```java
4242
@ApiModel(value = "登陆信息")
@@ -45,14 +45,14 @@
4545
- 类中字段需在 @ApiModelProperty 注解中加如下说明:
4646
- value:表示字段名
4747
- example:表示该字段的示例值,在测试时很有帮助
48-
- required: 若为必携带的参数,则为true
48+
- required: 若为必携带的参数,则为true
4949

5050
```java
5151
@ApiModelProperty(value = "用户名,可以为手机/邮箱", example = "[email protected]", required = true)
5252
```
5353

5454
- 若为普通参数:
55-
- 在方法的请求参数前,与 @RequestParam并列
55+
- 在方法的请求参数前,与 @RequestParam并列
5656

5757
```java
5858
@ApiParam(value = “用户ID”, example = "1100020")

0 commit comments

Comments
 (0)