add api doc

2025-01-11 14:40:55 +08:00 · 2024-12-05 10:05:22 +08:00 · 2024-12-05 10:05:22 +08:00 · edef08a114
commit edef08a114
parent d25d5e6e35
1 changed files with 115 additions and 0 deletions
--- a/docs/resources/根据id获取动态详情.md
+++ b/docs/resources/根据id获取动态详情.md
@ -0,0 +1,115 @@
+## 1. 根据id获取动态详情接口
+
+### 1.1 接口描述
+获取当前登录用户的个人信息。
+### 1.2 请求URL
+`/v1/post?id=`
+
+### 1.3 请求方式
+**GET**
+
+### 1.4 请求头
+| 头字段       | 必填 | 数据类型      | 描述                           |
+| ------------ | ---- | ------------- | -------------------------------- |
+
+
+### 1.5 请求体参数
+| 参数名称      | 必填 | 数据类型 | 约束条件 | 描述                        | 示例         | 允许空值 |
+|-----------| ---- | -------- | -------- | ---------------------------- | ------------ | -------- |
+
+
+### 1.6 请求示例
+```http
+GET /v1/post?id=100
+```
+
+### 1.7 返回参数说明
+| 参数名称 | 必填 | 数据类型 | 约束条件 | 描述        |
+|------| ---- | -------- | -- |-----------|
+| code | 是   | 整型   | | 错误码，0表示成功 |
+| msg  | 否   | 字符串   |  | 错误信息描述    |
+| data | 否  | json  |  | 具体业务数据    |
+
+data结构说明：
+
+| 参数名称     | 必填 | 数据类型 | 约束条件 | 描述   |
+|----------| --- | -------- |--|------|
+
+
+### 1.8 响应示例（成功）
+
+```json
+{
+  "code": 0,
+  "msg": "success",
+  "data": {
+    "id": 1080018001,
+    "user_id": 100066,
+    "user": {
+      "id": 100066,
+      "nickname": "xyz",
+      "username": "xyz",
+      "status": 1,
+      "avatar": "https://assets.paopao.info/public/avatar/default/jackson.png",
+      "is_admin": false,
+      "is_friend": false,
+      "is_following": false
+    },
+    "contents": [
+      {
+        "id": 180022571,
+        "post_id": 1080018001,
+        "content": "dddd",
+        "type": 2,
+        "sort": 100
+      }
+    ],
+    "comment_count": 0,
+    "collection_count": 0,
+    "share_count": 0,
+    "upvote_count": 0,
+    "visibility": 2,
+    "is_top": 0,
+    "is_essence": 0,
+    "is_lock": 0,
+    "latest_replied_on": 1716707657,
+    "created_on": 1716707657,
+    "modified_on": 1716707657,
+    "tags": {
+      "tag1": 1,
+      "tag2": 1
+    },
+    "attachment_price": 0,
+    "ip_loc": "山东省聊城市"
+  }
+}
+```
+### 1.9 响应示例（错误）
+```json
+{ "code": 500, "msg": "内部错误" }
+```
+
+### 1.10 错误响应码参考
+更多响应错误码及含义，请参阅[API响应码表](URL/for/api/responseCode/table)。
+
+### 1.11 安全性与认证
+
+
+### 1.12 测试环境
+访问测试环境以进行接口调试：
+[https://test.apiAddress.com](https://test.apiAddress.com)
+
+### 1.13 版本管理
+本API通过URI路径进行版本控制。请在请求URL中包含`/v1`以使用当前版本。
+
+### 1.14 更新记录
+- **2024-05-10**：新建
+
+
+
+### 1.15 联系支持
+如需帮助或对API有任何疑问，请通过电子邮件与我们联系：[support@api.com](mailto:support@api.com)。
+
+### 1.16 反馈与建议
+发现文档问题或有改进建议？请填写[反馈表单](https://forms.api.com/feedback)与我们分享。
+