76 lines
1.4 KiB
Markdown
76 lines
1.4 KiB
Markdown
# Jnote Server
|
|
|
|
博客后端 API 服务
|
|
|
|
## 安装
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
## 配置
|
|
|
|
编辑 `.env` 文件，填入数据库连接信息：
|
|
|
|
```
|
|
DB_HOST=localhost
|
|
DB_PORT=3306
|
|
DB_USER=root
|
|
DB_PASSWORD=your_password
|
|
DB_NAME=jnote
|
|
PORT=3000
|
|
```
|
|
|
|
如果不配置数据库，将使用内存存储作为后备方案。
|
|
|
|
## 启动
|
|
|
|
```bash
|
|
# 开发模式（热重载）
|
|
npm run dev
|
|
|
|
# 生产模式
|
|
npm start
|
|
```
|
|
|
|
## API 端点
|
|
|
|
### 文章
|
|
|
|
| 端点 | 方法 | 说明 |
|
|
|------|------|------|
|
|
| `/api/posts` | GET | 获取所有文章 |
|
|
| `/api/posts/:id` | GET | 获取单篇文章 |
|
|
| `/api/posts` | POST | 创建文章 |
|
|
| `/api/posts/:id` | PUT | 更新文章 |
|
|
| `/api/posts/:id` | DELETE | 删除文章 |
|
|
|
|
### 关于
|
|
|
|
| 端点 | 方法 | 说明 |
|
|
|------|------|------|
|
|
| `/api/about` | GET | 获取关于内容 |
|
|
| `/api/about` | PUT | 更新关于内容 |
|
|
|
|
### 设置
|
|
|
|
| 端点 | 方法 | 说明 |
|
|
|------|------|------|
|
|
| `/api/settings` | GET | 获取设置 |
|
|
| `/api/settings` | PUT | 更新设置 |
|
|
|
|
### 定时任务
|
|
|
|
| 端点 | 方法 | 说明 |
|
|
|------|------|------|
|
|
| `/api/cron-tasks` | GET | 获取所有任务 |
|
|
| `/api/cron-tasks` | POST | 创建任务 |
|
|
| `/api/cron-tasks/:id` | PUT | 更新任务 |
|
|
| `/api/cron-tasks/:id` | DELETE | 删除任务 |
|
|
| `/api/cron-tasks/:id/run` | POST | 立即执行任务 |
|
|
|
|
### 健康检查
|
|
|
|
| 端点 | 方法 | 说明 |
|
|
|------|------|------|
|
|
| `/api/health` | GET | 服务健康状态 | |