# books-web-source

**Repository Path**: jon/books-web-source

## Basic Information

- **Project Name**: books-web-source
- **Description**: 极简Web制源
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-03-18
- **Last Updated**: 2024-11-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 电脑端写源的工具

### 构建与安装
```
$ git clone https://gitee.com/jon/books-web-source
$ cd books-web-source
$ npm install 或 yarn # 推荐使用yarn
& npm run dev 或 npm run build
```

### 测试配置
```
打开文件 .env.development
设置 VITE_API_URL 地址为手机APP中的地址
浏览器中打开的地址必须是IP地址，如果为localhost则会打开为离线版本
```

### 框架
该工具主要依托于腾讯开源的<a href="https://tdesign.tencent.com/mobile-vue/overview">TDesign</a>框架上进行开发

### API方法介绍
#### 源列表  /api/site/list

| 请求参数 | 参数名称 | 是否必填 | 描述 |
| - | - | - | - |
| keyword | 搜索关键词 | 选填 | 可搜索源名称/源网址 |
| groupId | 源分组id | 选填 | - |

#### 书源分组列表 /api/site/group
| 请求参数 | 参数名称 | 是否必填 | 描述 |
| - | - | - | - |

#### 书源详情 /api/site/info

| 请求参数 | 参数名称 | 是否必填 | 描述 |
| - | - | - |----|
| id | 书源id | 必填 | -  |

#### 书源保存 /api/site/save

| 请求参数 | 参数名称    | 是否必填 | 描述 |
| - |---------| - | - |
| siteJson | 书源json串 | 必填 | 所有规则 |
| id | 书源id    | 选填 | 编辑时必填 |
| index | 排序 | 选填 | 数字越大越靠前 |
| groupId | 源分组id | 选填 | - |
| status | 搜索状态 | 选填 | Bool类型 |
| finderStatus | 发现状态 | 选填 | Bool类型 |
| remarks | 源笔记 | 选填 | - |

#### 书源删除 /api/site/delete

| 请求参数 | 参数名称    | 是否必填 | 描述 |
| - |---------| - | - |
| id | 书源id | 必填 | - |

#### 单个源导出 /api/site/export

| 请求参数 | 参数名称 | 是否必填 | 描述 |
| - |------|------| - |
|id | 书源id | 必填   |

#### 搜索调试 /api/site/search

| 请求参数 | 参数名称 | 是否必填 | 描述 |
| - |------|------| - |
|keyword|书名搜索词|必填|
|siteJson|书源JSON串|必填|

#### 章节调试 /api/site/bookinfo

| 请求参数 | 参数名称 | 是否必填 | 描述 |
| - |------|------| - |
|bookJson|书籍JSON格式|必填|json中新增了bookUrl字段，书籍详情使用此字段请求|
|siteJson|书源JSON串|必填|-|

#### 章节调试 /api/site/chapter

| 请求参数 | 参数名称 | 是否必填 | 描述 |
| - |------|------| - |
|bookJson|书籍JSON格式|必填|-|
|siteJson|书源JSON串|必填|-|

#### 正文调试 /api/site/content

| 请求参数 | 参数名称 | 是否必填 | 描述 |
| - |------|------| - |
|catalogJson|章节JSON格式|必填|-|
|siteJson|书源JSON格式|必填|-|

#### 发现调试 /api/site/finder

| 请求参数 | 参数名称 | 是否必填 | 描述 |
| - |------|------| - |
|siteJson|书源JSON格式|必填|-|
|categoryUUID|分类UUID|必填|-|
|selectList|选择筛选项|必填|格式：[(type: String, value: String)]|
|pageIndex|页码|必填|-|

#### 取消调试请求 /api/site/cancelRequest

| 请求参数 | 参数名称 | 是否必填 | 描述 |
| - |------|------| - |
|type|请求类型|必填|0搜索1章节2正文|

#### 调试清除 /api/debug/clear

| 请求参数       | 参数名称  | 是否必填 | 描述 |
|------------|-------|------| - |
| type       | 请求类型  | 必填 | 1清空搜索log<br/>2清空章节log<br/>3清空正文log<br/>4清空put，必传siteIdent<br/>5清空发现log |
| siteIdent  | 源标识 | 可选 | 使用清空put必填 |