This commit is contained in:
Kamisato-Ayaka-233
2023-05-20 16:09:34 +08:00
parent 56556213f7
commit 4257679326
3 changed files with 40 additions and 4 deletions

View File

@@ -66,7 +66,7 @@
- 请求方式接口的请求方式GET、POST或Socket等。HTTP请求方式最好使用大写字母。使用斜体。
- 请求头验证(按情况标识):一些接口需要验证请求头的信息,则需要标注“需要验证请求头”,置于引用块中并使用斜体。下一行需要标注请求头的信息,如`x-rpc-client_type`。见[鉴权](/other/authentication.md#请求头)以了解应该标注哪些请求头。若该接口需要验证额外的请求头,也需要标注。若不需要验证请求头,则无需标注。
- 鉴权(按情况标识):一些接口需要登录账号,则需要标注“需要验证网页/应用Cookie”置于引用块中并使用斜体。见[鉴权](/other/authentication.md#cookie)以了解Cookie的内容。若该接口需要验证额外的Cookie也需要标注。若不需要验证Cookie则无需标注。
- 接口网址URL接口的完整URL使用等宽字体。
- 接口网址URL接口的完整URL使用等宽字体。如果该功能的网页端和应用端API的URL不同则应全部列出。
- 备注(可选):该接口使用的注意事项。
例子:
@@ -88,6 +88,18 @@ _请求方式GET_
```
```markdown
## 获取用户所有文章
**国服:**
_请求方式GET_
网页:`https://bbs-api.miyoushe.com/post/wapi/userPost`
应用:`https://bbs-api.miyoushe.com/painter/api/user_instant/list`
```
### 请求参数
请求参数应该在[接口说明](#接口说明)下方。使用粗体。