diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..030d2de1 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,49 @@ + + +## 📌 关联的 Issue + + + +Closes # + +--- + +## 📝 更改类型 + + + +- [ ] 格式化 +- [ ] 新增 API +- [ ] 修正错误 +- [ ] 更改依赖 +- [ ] 更改工作流 +- [ ] 其他(请在更改描述里面填写类型) + +--- + +## 📖 更改描述 + + + +--- + +## 🧪 测试与验证说明 + + + +- [ ] 我确认文档能够正常构建 + +--- + +## 🏁 自查清单 + + + +- [ ] 我提交的内容符合本项目的[内容规范](https://yh-api.yyyyt.top/contribution_guide.html#内容规范) +- [ ] 我已经对提交内容进行了初步的审查 diff --git a/src/.vuepress/navbar.ts b/src/.vuepress/navbar.ts index 45aef4ac..72173580 100644 --- a/src/.vuepress/navbar.ts +++ b/src/.vuepress/navbar.ts @@ -3,31 +3,36 @@ import { navbar } from "vuepress-theme-hope"; export default navbar([ "/", { - text: "API文档", - icon: "book", - prefix: "/api/", - children: [ - { - text: "v1", - link: "v1/" - }, - { - text: "wss", - link: "wss/" - }, - { - text: "web", - link: "web/" - }, - { - text: "bot", - link: "bot/" - }, - ] + text: "API文档", + icon: "book", + prefix: "/api/", + children: [ + { + text: "v1", + link: "v1/", + }, + { + text: "wss", + link: "wss/", + }, + { + text: "web", + link: "web/", + }, + { + text: "bot", + link: "bot/", + }, + ], }, { - text: "API吐槽", - icon: "comment", - link: "/云湖API吐槽/", + text: "API吐槽", + icon: "comment", + link: "/云湖API吐槽/", }, -]) + { + text: "贡献指南", + icon: "book", + link: "/contribution_guide", + }, +]); diff --git a/src/api/url_scheme.md b/src/api/url_scheme.md index 13d1f12e..62d0a14e 100644 --- a/src/api/url_scheme.md +++ b/src/api/url_scheme.md @@ -8,12 +8,13 @@ yunhu://chat-add 参数: -| 名称 | 必须 | 备注 | -| ----- | ---- | ---- | -| id | 是 | 要添加的目标对象ID | -| type | 是 | 要添加的目标对象类别，用户-user，群聊-group，机器人-bot | +| 名称 | 必须 | 备注 | +| ---- | ---- | ------------------------------------------------------- | +| id | 是 | 要添加的目标对象ID | +| type | 是 | 要添加的目标对象类别，用户-user，群聊-group，机器人-bot | 实例（添加ID为123的用户）： + ```text yunhu://chat-add?id=123&type=user ``` @@ -24,11 +25,12 @@ yunhu://post-detail 参数: -| 名称 | 必须 | 备注 | -| ----- | ---- | ---- | -| id | 是 | 要跳转的目标文章ID | +| 名称 | 必须 | 备注 | +| ---- | ---- | ------------------ | +| id | 是 | 要跳转的目标文章ID | 实例（跳转到ID为111的文章）： + ```text yunhu://post-detail?id=111 ``` @@ -39,11 +41,12 @@ yunhu://alley-detail 参数: -| 名称 | 必须 | 备注 | -| ----- | ---- | ---- | -| id | 是 | 要跳转的目标文章分区ID | +| 名称 | 必须 | 备注 | +| ---- | ---- | ---------------------- | +| id | 是 | 要跳转的目标文章分区ID | 实例（跳转到ID为41的文章分区）： + ```text yunhu://post-detail?id=41 ``` @@ -54,11 +57,12 @@ yunhu://ad 参数: -| 名称 | 必须 | 备注 | -| ----- | ---- | ---- | -| id | 是 | 要观看的广告ID | +| 名称 | 必须 | 备注 | +| ---- | ---- | -------------- | +| id | 是 | 要观看的广告ID | 实例（观看广告ID为123的广告）： + ```text yunhu://ad?id=123 ``` diff --git a/src/api/v1/group.md b/src/api/v1/group.md index c0c33551..a202a8c5 100644 --- a/src/api/v1/group.md +++ b/src/api/v1/group.md @@ -384,7 +384,7 @@ POST /v1/group/remove-member ### 请求头 | 名称 | 必须 | 备注 | -| ----- | ---- |-------------------------| +| ----- | ---- | ----------------------- | | token | 是 | 必须为群主或管理员token | ### 请求体 @@ -414,7 +414,7 @@ POST /v1/group/gag-member ### 请求头 | 名称 | 必须 | 备注 | -| ----- | ---- |-------------------------| +| ----- | ---- | ----------------------- | | token | 是 | 必须为群主或管理员token | ### 请求体 @@ -1086,9 +1086,9 @@ POST /v1/group/create-group ### 请求头 -| 名称 | 必须 | 备注 | -| ----- | ---- |--------------| -| token | 是 | 无 | +| 名称 | 必须 | 备注 | +| ----- | ---- | ---- | +| token | 是 | 无 | ### 请求体 @@ -1140,8 +1140,8 @@ POST /v1/group/dismiss-group ### 请求头 -| 名称 | 必须 | 备注 | -| ----- | ---- |--------------| +| 名称 | 必须 | 备注 | +| ----- | ---- | ---- | | token | 是 | 群主 | ### 请求体 @@ -1232,9 +1232,9 @@ POST /v1/group/agree-invite 请求头： -| 名称 | 必须 | 备注 | -| ----- | ---- |--------------| -| token | 是 | 无 | +| 名称 | 必须 | 备注 | +| ----- | ---- | ---- | +| token | 是 | 无 | 请求体： @@ -1262,9 +1262,9 @@ POST /v1/group/member-is-removed 请求头： -| 名称 | 必须 | 备注 | -| ----- | ---- |--------------| -| token | 是 | 无 | +| 名称 | 必须 | 备注 | +| ----- | ---- | ---- | +| token | 是 | 无 | 请求体： @@ -1292,9 +1292,9 @@ POST /v1/group/switch 请求头： -| 名称 | 必须 | 备注 | -| ----- | ---- |--------------| -| token | 是 | 无 | +| 名称 | 必须 | 备注 | +| ----- | ---- | ---- | +| token | 是 | 无 | 请求体： diff --git a/src/api/v1/instruction.md b/src/api/v1/instruction.md index 86c20174..d5ea2450 100644 --- a/src/api/v1/instruction.md +++ b/src/api/v1/instruction.md @@ -234,4 +234,4 @@ message instruction_list { } ``` -::: \ No newline at end of file +::: diff --git a/src/api/v1/live.md b/src/api/v1/live.md index f6ea06da..888d1b1d 100644 --- a/src/api/v1/live.md +++ b/src/api/v1/live.md @@ -216,8 +216,8 @@ POST /v1/live/stream-info 请求头: -| 名称 | 必须 | 备注 | -| ----- | ---- | ------- | +| 名称 | 必须 | 备注 | +| ----- | ---- | -------- | | token | 是 | VIP 用户 | 请求体： @@ -255,4 +255,4 @@ POST /v1/live/stream-info { "code":-1, "msg":"功能仅限VIP用户使用" } ``` -::: \ No newline at end of file +::: diff --git a/src/api/v1/mount-setting.md b/src/api/v1/mount-setting.md index 9fcff1cc..0e5523f2 100644 --- a/src/api/v1/mount-setting.md +++ b/src/api/v1/mount-setting.md @@ -11,8 +11,8 @@ POST /v1/mount-setting/create 请求头: -| 名称 | 必须 | 备注 | -| ----- | ---- | ----------------- | +| 名称 | 必须 | 备注 | +| ----- | ---- | ---------------------------------------- | | token | 是 | 普通用户的 token 也可(若后续改了欢迎 PR) | 请求体: @@ -43,8 +43,8 @@ POST /v1/mount-setting/delete 请求头: -| 名称 | 必须 | 备注 | -| ----- | ---- | ----------------- | +| 名称 | 必须 | 备注 | +| ----- | ---- | ---------------------------------------- | | token | 是 | 普通用户的 token 也可(若后续改了欢迎 PR) | 请求体: diff --git a/src/api/v1/msg.md b/src/api/v1/msg.md index 39d33fdd..524445b2 100644 --- a/src/api/v1/msg.md +++ b/src/api/v1/msg.md @@ -90,7 +90,7 @@ message send_message_send { ### 任何消息 -下面说的各种消息是需要额外注意/填写部分,填写内容建议看 proto 的注释. +下面说的各种消息是需要额外注意/填写部分,填写内容建议看 proto 的注释. 必填: @@ -115,7 +115,7 @@ message send_message_send { 此处文本类消息指 `普通文本`,`html 消息`,`markdown 消息`. 必填: -- `data.text` +- `data.text` @tab 图片消息 @@ -1071,9 +1071,9 @@ POST /v1/msg/delete 请求头： -| 名称 | 必须 | 备注 | -| ----- | ---- |--------------| -| token | 是 | 无 | +| 名称 | 必须 | 备注 | +| ----- | ---- | ---- | +| token | 是 | 无 | 请求体： diff --git a/src/api/v1/user.md b/src/api/v1/user.md index 61f466ab..45ed1438 100644 --- a/src/api/v1/user.md +++ b/src/api/v1/user.md @@ -732,7 +732,7 @@ POST /v1/user/gold-coin-increase-decrease-record POST /v1/user/bing-phone -!!不要问为什么是 bing,我也不知道.!! +!!不要问为什么是 bing,我也不知道.!! 请求头: @@ -762,7 +762,7 @@ POST /v1/user/bing-phone POST /v1/user/bing-email -!!不要问为什么是 bing,我也不知道.!! +!!不要问为什么是 bing,我也不知道.!! 请求头: @@ -993,7 +993,7 @@ POST /v1/user/save-user-remarks POST /v1/user/cancel-user -!!谁 TMD 想出来的这种命名?!! +!!谁 TMD 想出来的这种命名?!! 请求头: diff --git a/src/contribution_guide.md b/src/contribution_guide.md new file mode 100644 index 00000000..979e4e5e --- /dev/null +++ b/src/contribution_guide.md @@ -0,0 +1,71 @@ +--- +title: 贡献指南 +icon: book +--- + +## 简言: + +本文将会教您如何正确贡献内容给 API 文档,以及一些注意事项. +在贡献之前,请确保您有以下基础: + +- VuePress 基础 +- Markdown 基础 +- CLI 基础 +- Git 基础 +- 正确使用 AI 工具的基础 +- 抓包/调试基础 + +如果没有以上基础可以学. + +## 内容规范: + +1. JSON 请求类型应该写 JSON,而不是 JSONC. +2. 注释完备,但是不要过度注释,目前不需要注释的内容有: status 中普通的 code 和 msg(特殊的仍然需要注释). + protobuf(含 proto) 中的 chat_type 和 content_type 均不需要注明数字对应的类型,文档 API 目录首页已经注明,除非存在不一致的情况. + 如果需要写数字对应的类型请按照以下格式: + +```JSON +{ + "type": 1 // XX 类型: 1-类型1, 2-类型2, 3-类型3 ... +} +``` + +3. 遵循[中文排版指南](https://github.com/aaranxu/chinese-copywriting-guidelines) + 不要求遵循争议和推荐部分,标点符号的全角半角不强制要求遵循. +4. 所写内容应能通过 VuePress 构建并且页面内容正常显示. + +## 如何贡献: + +1. Fork [本仓库](https://github.com/yh-Tpdev/yhchatAPI)到自己账号名下. +2. 通过抓包等方式获取修改依据. +3. Git clone Fork 后的仓库到本地后修改并提交或者是直接在 GitHub 网页编辑器(不推荐)修改. +4. 测试是否能够正常构建. +5. 提交更改到远程仓库 +6. 创建一个 Pull Request 提交更改. + 请务必如实填写要求填写的内容,不符合要求可能会被打回.您可以到相关群聊询问审核人员请求审查和合并. + +## 项目命令: + +补全依赖 + +```bash +pnpm install +``` + +启动开发服务器 + +```bash +pnpm docs:dev +``` + +构建文档 + +```bash +pnpm docs:build +``` + +更新依赖(如果您执行了此项操作审核人员可能会加严审核) + +```bash +pnpm dlx vp-update +``` diff --git "a/src/\344\272\221\346\271\226API\345\220\220\346\247\275/1ctrl-cv.md" "b/src/\344\272\221\346\271\226API\345\220\220\346\247\275/1ctrl-cv.md" index 2a4bf984..c1231b01 100644 --- "a/src/\344\272\221\346\271\226API\345\220\220\346\247\275/1ctrl-cv.md" +++ "b/src/\344\272\221\346\271\226API\345\220\220\346\247\275/1ctrl-cv.md" @@ -1,5 +1,7 @@ --- title: B84F2246 +author: B84F2246 --- + 第二 我待会再来写这个 diff --git "a/src/\344\272\221\346\271\226API\345\220\220\346\247\275/QianLin-Jiaxi.md" "b/src/\344\272\221\346\271\226API\345\220\220\346\247\275/QianLin-Jiaxi.md" index b65cf9ad..18a90a9c 100644 --- "a/src/\344\272\221\346\271\226API\345\220\220\346\247\275/QianLin-Jiaxi.md" +++ "b/src/\344\272\221\346\271\226API\345\220\220\346\247\275/QianLin-Jiaxi.md" @@ -1,18 +1,20 @@ --- title: QianLin-Jiaxi +author: QianLin-Jiaxi --- + md，云湖后端简直逆天 -这么说可能不怎么好理解，我举个实例: +这么说可能不怎么好理解，我举个实例: 1.莫名奇妙多出的相同属性数值，明明在前面已经有了相应的数值却还要重复一遍，增加包大小（ 2.一堆json转义，数组不嫌多的往请求里塞，愣是不好好写json（ 3.人无法理解的proto，设计自带防破解，根本看不懂（ -4.一堆永远是空的数值，后端还™的必须检验是否存在，不然就报错（ +4.一堆永远是空的数值，后端还™的必须检验是否存在，不然就报错（ -前端也差不多，在我测试时也发现了各种稀奇的问题： +前端也差不多，在我测试时也发现了各种稀奇的问题： 1.有较大部分逻辑没有做数值校验，一旦数值错误直接渲染报错，组件原地灰屏（ -2.一堆地方文件大小校验没做，流量炸弹直接boom！ +2.一堆地方文件大小校验没做，流量炸弹直接boom！ 总结，离神不知道近不近，但离人肯定很远了，散会！ PS：怨气很重 + MAX^MAX (╬▔皿▔)凸 diff --git "a/src/\344\272\221\346\271\226API\345\220\220\346\247\275/ccd2s.md" "b/src/\344\272\221\346\271\226API\345\220\220\346\247\275/ccd2s.md" index ec02fb83..4c8d20a9 100644 --- "a/src/\344\272\221\346\271\226API\345\220\220\346\247\275/ccd2s.md" +++ "b/src/\344\272\221\346\271\226API\345\220\220\346\247\275/ccd2s.md" @@ -1,5 +1,6 @@ --- title: ccD2s +author: ccD2s --- 云湖后端还是太神秘了，请听我给你慢慢分解：