|
@@ -44,7 +44,9 @@ user
|
|
|
|
|
|
|
|
#### api 文件内容结构
|
|
#### api 文件内容结构
|
|
|
|
|
|
|
|
-````markdown
|
|
|
|
|
|
|
+> 下所有 [``] 均为 [```]
|
|
|
|
|
+
|
|
|
|
|
+```markdown
|
|
|
# 命名
|
|
# 命名
|
|
|
|
|
|
|
|
> url 前缀：**user**
|
|
> url 前缀：**user**
|
|
@@ -55,21 +57,21 @@ user
|
|
|
|
|
|
|
|
⬇️ 为路径参数格式 :userId 表示变量
|
|
⬇️ 为路径参数格式 :userId 表示变量
|
|
|
|
|
|
|
|
-```http
|
|
|
|
|
|
|
+``http
|
|
|
post /:userId
|
|
post /:userId
|
|
|
-```
|
|
|
|
|
|
|
+``
|
|
|
|
|
|
|
|
### Parameters
|
|
### Parameters
|
|
|
|
|
|
|
|
⬇️ 为 post body 中的参数格式
|
|
⬇️ 为 post body 中的参数格式
|
|
|
|
|
|
|
|
-```json
|
|
|
|
|
|
|
+``json
|
|
|
{
|
|
{
|
|
|
"nickname": "nickname",
|
|
"nickname": "nickname",
|
|
|
"avatar": "xxxxxxxxxx",
|
|
"avatar": "xxxxxxxxxx",
|
|
|
"bio": "小白白白白白白白白白白白"
|
|
"bio": "小白白白白白白白白白白白"
|
|
|
}
|
|
}
|
|
|
-```
|
|
|
|
|
|
|
+``
|
|
|
|
|
|
|
|
⬇️ 为问号传参格式 example： user?userId=1
|
|
⬇️ 为问号传参格式 example： user?userId=1
|
|
|
|
|
|
|
@@ -80,11 +82,11 @@ post /:userId
|
|
|
|
|
|
|
|
### Response
|
|
### Response
|
|
|
|
|
|
|
|
-```json
|
|
|
|
|
|
|
+``json
|
|
|
{
|
|
{
|
|
|
"data": UserSerializer
|
|
"data": UserSerializer
|
|
|
}
|
|
}
|
|
|
-```
|
|
|
|
|
|
|
+``
|
|
|
|
|
|
|
|
see [UserSerializer](../serializer/UserSerializer.md)
|
|
see [UserSerializer](../serializer/UserSerializer.md)
|
|
|
|
|
|
|
@@ -92,7 +94,7 @@ see [UserSerializer](../serializer/UserSerializer.md)
|
|
|
|
|
|
|
|
etc...
|
|
etc...
|
|
|
|
|
|
|
|
-````
|
|
|
|
|
|
|
+```
|
|
|
|
|
|
|
|
## serializer文件结构
|
|
## serializer文件结构
|
|
|
|
|
|
