Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions src/.vuepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,5 @@ export default defineUserConfig({

// 和 PWA 一起启用
// shouldPrefetch: false,
plugins: [
llmsPlugin({
})
]
plugins: [llmsPlugin({})],
});
22 changes: 10 additions & 12 deletions src/.vuepress/sidebar.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
import { sidebar } from "vuepress-theme-hope";

export default sidebar(
{
"/api/": "structure",
"/api/v1/": "structure",
"/api/wss/": "structure",
"/云湖API吐槽/": "structure",
"/api/web/v1/": "structure",
"/api/bot/": "structure",
"/api/web/": "structure",
"/api/bot/接入准备/": "structure"
}
);
export default sidebar({
"/api/": "structure",
"/api/v1/": "structure",
"/api/wss/": "structure",
"/云湖API吐槽/": "structure",
"/api/web/v1/": "structure",
"/api/bot/": "structure",
"/api/web/": "structure",
"/api/bot/接入准备/": "structure",
});
2 changes: 1 addition & 1 deletion src/.vuepress/theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ export default hopeTheme({
},

copyCode: {
showInMobile: true
showInMobile: true,
},

icon: {
Expand Down
12 changes: 6 additions & 6 deletions src/api/web/v1/bot.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ POST /v1/bot/bot-info

请求体:

```JSONC
```JSON
{
"botId": "13972254" // 你要查询bot的ID
"botId": "13972254" // 你要查询 bot 的 ID
}
```

响应体:

```JSONC
```JSON
{
"code": 1,
"data": {
Expand Down Expand Up @@ -50,7 +50,7 @@ POST /v1/bot/bot-info
}
}
},
"msg": "success" // 返回消息
"msg": "success"
}
```

Expand All @@ -66,15 +66,15 @@ POST /v1/bot/bot-link-reset

请求体:

```JSONC
```JSON
{
"botId": "123", // 机器人ID
}
```

响应体:

```JSONC
```JSON
{
"code": 1, // 请求状态码,1为正常
"msg": "success" // 返回消息
Expand Down
4 changes: 2 additions & 2 deletions src/api/web/v1/common.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ GET /v1/common/get-version

响应体:

```JSONC
```JSON
{
"code": 1,
"data": {
Expand All @@ -28,6 +28,6 @@ GET /v1/common/get-version
"windowsVersion": "1.6.39", // Windows最新版本号
"windowsVersionDate": "2025/11/02" // Windows最新版本更新时间
},
"msg": "success" // 返回消息
"msg": "success"
}
```
18 changes: 9 additions & 9 deletions src/api/web/v1/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ title: community
---

未特别说明情况下请求域名均为 `chat-web-go.jwzhd.com`
没写请求/响应项目表示不需要相关参数.
没写请求/响应项目表示不需要相关参数.

## 获取分区列表

POST /v1/community/c/following-ba-list

请求体:

```JSONC
```JSON
{
"size": 100, // 一页返回的数量
"page": 1 // 页码
Expand All @@ -20,7 +20,7 @@ POST /v1/community/c/following-ba-list

响应体:

```JSONC
```JSON
{
"code": 1, // 请求状态码,1为正常
"data": {
Expand Down Expand Up @@ -51,7 +51,7 @@ POST /v1/community/posts/post-list

请求体:

```JSONC
```JSON
{
"typ": 1, // 典型值
"baId": 41, // 分区 id
Expand All @@ -62,7 +62,7 @@ POST /v1/community/posts/post-list

响应体:

```JSONC
```JSON
{
"code": 1, // 请求状态码,1为正常
"data": {
Expand Down Expand Up @@ -119,17 +119,17 @@ POST /v1/community/c/info

请求体:

```JSONC
```JSON
{
"id": 41 // 分区 id
}
```

响应体:

```JSONC
```JSON
{
"code": 1, // 请求状态码,1为正常
"code": 1,
"data": {
"ba": {
"id": 41, // 分区 id
Expand All @@ -145,6 +145,6 @@ POST /v1/community/c/info
"isFollowed": "0" // 你是否关注了此分区(1为已关注,0为未关注)
}
},
"msg": "success" // 返回消息
"msg": "success"
}
```
16 changes: 8 additions & 8 deletions src/api/web/v1/document.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ GET /v1/document/menus

响应体:

```JSONC
```JSON
{
"code": 1, // 请求状态码,1为正常
"code": 1,
"data": {
"menu": [
{
Expand Down Expand Up @@ -44,7 +44,7 @@ GET /v1/document/menus
// ...
]
},
"msg": "success" // 返回消息
"msg": "success"
}
```

Expand All @@ -54,15 +54,15 @@ GET /v1/document/detail

请求参数:

| 名称 | 必须 | 备注 |
| ---------- | ---- | ------------------------------ |
| 名称 | 必须 | 备注 |
| ---------- | ---- | ------------------------- |
| documentId | 是 | 大小写敏感,类型必须是 int |

响应体:

```JSONC
```JSON
{
"code": 1, // 请求状态码,1为正常
"code": 1,
"data": {
"detail": {
"id": 4, // 文档id
Expand All @@ -79,6 +79,6 @@ GET /v1/document/detail
"remark": "11" // 不知道
}
},
"msg": "success" // 返回消息
"msg": "success"
}
```
14 changes: 7 additions & 7 deletions src/api/web/v1/rss.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ title: rss
---

未特别说明情况下请求域名均为 `chat-web-go.jwzhd.com`
没写请求/响应项目表示不需要相关参数.
没写请求/响应项目表示不需要相关参数.

## 获取 RSS 推荐大全

GET /v1/rss/recommend-list

响应体:

```JSONC
```JSON
{
"code": 1, // 请求状态码,1为正常
"code": 1,
"data": {
"list": [
{
Expand All @@ -39,17 +39,17 @@ GET /v1/rss/recommend-list
],
"total": 28 // RSS 推荐总数
},
"msg": "success" // 返回消息
"msg": "success"
}
```

## 提交 RSS

POST /v1/rss/recommend-apply

请求体:
请求体:

```JSONC
```JSON
{
"title": "轻雨Purainity的小站", // 网站标题
"rssUrl": "https://jibukeshi.dpdns.org/rss.xml", // RSS 地址
Expand All @@ -60,7 +60,7 @@ POST /v1/rss/recommend-apply

响应体:

```JSONC
```JSON
{
"code": 1, // 请求状态码,1为正常
"msg": "success" // 返回消息
Expand Down
2 changes: 1 addition & 1 deletion src/api/wss/chat-ws-go.jwzhd.com.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: chat-ws-go.jwzhd.com
---

> 本文章下所有 wss 请求地址均为 `wss://chat-ws-go.jwzhd.com/ws`
> 本文章下所有 wss 请求地址均为 `wss://chat-ws-go.jwzhd.com/ws`

没写 请求/响应项目 表示不需要相关参数,使用以下功能前必须先链接 wss 并 **登录云湖账号** 。

Expand Down
3 changes: 2 additions & 1 deletion src/contribution_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,15 @@ icon: book
3. 遵循[中文排版指南](https://github.com/aaranxu/chinese-copywriting-guidelines)
不要求遵循争议和推荐部分,标点符号的全角半角不强制要求遵循.
4. 所写内容应能通过 VuePress 构建并且页面内容正常显示.
5. commit 提交内容必须有意义.

## 如何贡献:

1. Fork [本仓库](https://github.com/yh-Tpdev/yhchatAPI)到自己账号名下.
2. 通过抓包等方式获取修改依据.
3. Git clone Fork 后的仓库到本地后修改并提交或者是直接在 GitHub 网页编辑器(不推荐)修改.
4. 测试是否能够正常构建.
5. 提交更改到远程仓库
5. 提交更改到远程仓库.
6. 创建一个 Pull Request 提交更改.
请务必如实填写要求填写的内容,不符合要求可能会被打回.您可以到相关群聊询问审核人员请求审查和合并.

Expand Down