docs(frontend): 更新 API 文档并部署到 GitHub Pages

Author: 2977094657

.github/workflows/deploy.yml

@@ -0,0 +1,69 @@
+# 部署到 GitHub Pages 的工作流
+name: Deploy VitePress site to Pages
+
+on:
+  # 在推送到 main 分支时触发
+  push:
+    branches: [main]
+  # 允许手动触发工作流
+  workflow_dispatch:
+
+# 设置 GITHUB_TOKEN 的权限，允许部署到 GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# 只允许一个并发部署，跳过正在运行和最新队列之间的运行队列
+# 但是，不要取消正在进行的运行，因为我们希望允许这些生产部署完成
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # 构建工作
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # 如果未启用 lastUpdated，则不需要
+      
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: npm
+          cache-dependency-path: frontend/package-lock.json
+      
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      
+      - name: Install dependencies
+        run: |
+          cd frontend
+          npm ci
+      
+      - name: Build with VitePress
+        run: |
+          cd frontend
+          npm run docs:build
+      
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: frontend/docs/.vitepress/dist
+
+  # 部署工作
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -3,3 +3,4 @@
 /frontend/node_modules/
 /.idea/
 /frontend/docs/.vitepress/cache/
+/frontend/docs/.vitepress/dist/

README.md

@@ -6,53 +6,47 @@
 
 这是一个获取滴答清单API接口项目，提供包括任务管理、专注记录、习惯打卡、数据导出等功能。
 
+## 🌐 在线文档
+
+- **📖 API文档**: [https://2977094657.github.io/DidaAPI/](https://2977094657.github.io/DidaAPI/)
+- **💻 项目地址**: [https://github.com/2977094657/DidaAPI](https://github.com/2977094657/DidaAPI)
+
 ## 📋 API接口清单
 
-### 🔐 认证相关 (/auth)
-- [x] **微信登录**
+- [x] **🔐 认证相关 (/auth)**
   - [x] `GET /auth/wechat/qrcode` - 获取微信登录二维码
   - [x] `GET /auth/wechat/poll` - 轮询登录状态（自动检测）
   - [x] `GET /auth/wechat/validate` - 验证微信登录
-- [x] **密码登录**
   - [x] `POST /auth/password/login` - 密码登录
-- [x] **手动认证**
   - [x] `POST /tasks/set-auth` - 手动设置认证（通常不需要）
 
-### 📝 任务管理 (/tasks)
-- [x] **任务查询**
+- [x] **📝 任务管理 (/tasks)**
   - [x] `GET /tasks/all` - 获取所有任务
   - [x] `GET /tasks/completed` - 获取已完成/已放弃任务（支持分页）
   - [x] `GET /tasks/trash` - 获取垃圾桶任务
   - [x] `GET /tasks/summary` - 获取任务统计
 
-### 📂 清单管理 (/projects)
-- [x] **清单查询**
+- [x] **📂 清单管理 (/projects)**
   - [x] `GET /projects/all` - 获取清单列表
 
-### 📊 统计分析 (/statistics)
-- [x] **用户统计**
+- [x] **📊 统计分析 (/statistics)**
   - [x] `GET /statistics/ranking` - 获取用户排名统计
   - [x] `GET /statistics/general` - 获取通用统计信息
-- [x] **任务统计**
   - [x] `GET /statistics/tasks` - 获取任务统计信息
 
-### 🍅 专注记录 (/pomodoros)
-- [x] **专注查询**
+- [x] **🍅 专注记录 (/pomodoros)**
   - [x] `GET /pomodoros/general` - 获取番茄专注概览
   - [x] `GET /pomodoros/distribution` - 获取专注详情分布
   - [x] `GET /pomodoros/timeline` - 获取专注记录时间线
 
-### 🎯 习惯管理 (/habits)
-- [x] **习惯查询**
+- [x] **🎯 习惯管理 (/habits)**
   - [x] `GET /habits/all` - 获取所有习惯
   - [x] `GET /habits/statistics/week/current` - 获取本周习惯打卡统计
 
-### 👤 用户信息 (/user)
-- [x] **用户资料**
+- [x] **👤 用户信息 (/user)**
   - [x] `GET /user/info` - 获取用户信息
 
-### 📤 数据导出 (/custom/export)
-- [x] **Excel导出**
+- [x] **📤 数据导出 (/custom/export)**
   - [x] `GET /custom/export/tasks/excel` - 导出任务到Excel
   - [x] `GET /custom/export/focus/excel` - 导出专注记录到Excel
 

frontend/docs/.vitepress/config.mts

@@ -4,6 +4,7 @@ export default defineConfig({
   title: '滴答清单API文档',
   description: '滴答清单API接口文档',
   lang: 'zh-CN',
+  base: '/DidaAPI/',
 
   head: [
     ['meta', { name: 'viewport', content: 'width=device-width, initial-scale=1.0' }],
@@ -16,7 +17,7 @@ export default defineConfig({
     nav: [
       { text: '首页', link: '/' },
       { text: 'API文档', link: '/api/' },
-      { text: '项目地址', link: 'https://github.com/your-repo' }
+      { text: '项目地址', link: 'https://github.com/2977094657/DidaAPI' }
     ],
 
     sidebar: {
@@ -109,7 +110,7 @@ export default defineConfig({
     },
 
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/your-repo' }
+      { icon: 'github', link: 'https://github.com/2977094657/DidaAPI' }
     ],
 
 

frontend/docs/api/tasks/get-all-tasks.md

@@ -401,5 +401,5 @@ X-Tz: Asia/Shanghai
 ## 相关接口
 
 - [验证微信登录](../auth/validate-wechat-login.md) - 获取认证令牌
-- [创建任务](./create-task.md) - 创建新任务
-- [更新任务](./update-task.md) - 更新任务信息
+- [获取已完成任务](./get-completed-tasks.md) - 获取已完成任务列表
+- [获取垃圾桶任务](./get-trash-tasks.md) - 获取垃圾桶任务列表

frontend/docs/index.md

@@ -11,6 +11,9 @@ hero:
     - theme: brand
       text: 查看API文档
       link: /api/
+    - theme: alt
+      text: GitHub项目
+      link: https://github.com/2977094657/DidaAPI
 
 
 ---