Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@yige233
yige233 authored Mar 30, 2023
1 parent d5bdd6c commit 84e2112
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,29 @@ A:可以把它做成服务，随电脑启动而启动，且在后台持续运行
- V2对API进行了大量修改，因此不能兼容使用V1 API的程序。
- 对比V1，V2的API更加规整了，以及多了些有的没的的细节更改

### config.js
- 一个常量就是一个配置项
- 使用.js作为配置项，就可以直接把配置import到程序里，不用读取文件什么的了
- 缺点是没法动态读取配置，配置修改后要重启服务

| 配置项 | 默认值 | 说明 |
| ------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| port | 3000 | 程序使用的端口。如果和其他程序有冲突，就得改成其他的（建议在1000-65535之间） |
| allowedPicExt | `[".jpg", ".jpeg", ".png"]` | 只检测拥有这个列表里的格式的文件。也可以添加其他非图片的格式，不过这还需要稍微修改一下代码，以便于程序能够正确输出它的MimeType |
| docUrl | `https://github.com/yige233/randomPic#readme` | API的文档链接 |
| enableMd5 | false | 是否在输出图片时为图片添加md5信息，即添加`Content-MD5`头 |
| collections | `{ collectionName : [ source1, source2, ...] }` | 核心配置。此处配置api将用到的图片的源。下面称其为 `图册` 。<br> 图册下面有多个收藏夹，每个收藏夹都是图册的一个属性。属性名可随意，但不能使用这些特殊字符：` / \| \ : ? @ # = ; `。该属性名也作为该收藏夹的名称。<br> 收藏夹的值是一个数组，数组内是若干个驱动对象。<br> 驱动对象的用处，是用来将不同类型的图片源整合成api可统一访问的形式。 |

- 驱动对象的结构：`{ type, data }`

| type可选的值 | 说明 | 对应的data的结构 | 说明 |
| ------------- | --------------------------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| localFolder | 表示类型为本地文件夹（会遍历子文件夹） | `[folderPath, ...]` | 数组，元素是文件夹路径。Windows下路径中的反斜杠应改成正斜杠: \ => / |
| localPic | 表示类型为本地文件 | `[picPath, ...]` | 数组，元素是文件路径。Windows下路径中的反斜杠应改成正斜杠: \ => / |
| AlistV3Folder | 表示类型为Alist V3 文件夹（不会遍历子文件夹） | `{ host: string, paths: array, ?passwd: string }` | 数组，元素是一个对象，分别有`host`(alist地址)、`paths`(数组，元素是alist文件夹挂载路径)和`passwd`(访问密码)三个属性 |
| AlistV3Pic | 表示类型为Alist V3 文件 | `{ host: string, paths: array, ?passwd: string }` | 数组，元素是一个对象，分别有`host`(alist地址)、`paths`(数组，元素是alist文件路径)和`passwd`(访问密码)三个属性 |


### API
- 如无特殊情形，响应体的`Content-Type`均为`application/json;charset=UTF-8`
- 如无特殊情形，响应体的json结构应如下：
Expand Down Expand Up @@ -143,26 +166,3 @@ A:可以把它做成服务，随电脑启动而启动，且在后台持续运行
*一堆图片二进制数据*
```


### config.js
- 一个常量就是一个配置项
- 使用.js作为配置项，就可以直接把配置import到程序里，不用读取文件什么的了
- 缺点是没法动态读取配置，配置修改后要重启服务

| 配置项 | 默认值 | 说明 |
| ------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| port | 3000 | 程序使用的端口。如果和其他程序有冲突，就得改成其他的（建议在1000-65535之间） |
| allowedPicExt | `[".jpg", ".jpeg", ".png"]` | 只检测拥有这个列表里的格式的文件。也可以添加其他非图片的格式，不过这还需要稍微修改一下代码，以便于程序能够正确输出它的MimeType |
| docUrl | `https://github.com/yige233/randomPic#readme` | API的文档链接 |
| enableMd5 | false | 是否在输出图片时为图片添加md5信息，即添加`Content-MD5`头 |
| collections | `{ collectionName : [ source1, source2, ...] }` | 核心配置。此处配置api将用到的图片的源。下面称其为 `图册` 。<br> 图册下面有多个收藏夹，每个收藏夹都是图册的一个属性。属性名可随意，但不能使用这些特殊字符：` / \| \ : ? @ # = ; `。该属性名也作为该收藏夹的名称。<br> 收藏夹的值是一个数组，数组内是若干个驱动对象。<br> 驱动对象的用处，是用来将不同类型的图片源整合成api可统一访问的形式。 |

- 驱动对象的结构：`{ type, data }`

| type可选的值 | 说明 | 对应的data的结构 | 说明 |
| ------------- | --------------------------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| localFolder | 表示类型为本地文件夹（会遍历子文件夹） | `[folderPath, ...]` | 数组，元素是文件夹路径。Windows下路径中的反斜杠应改成正斜杠: \ => / |
| localPic | 表示类型为本地文件 | `[picPath, ...]` | 数组，元素是文件路径。Windows下路径中的反斜杠应改成正斜杠: \ => / |
| AlistV3Folder | 表示类型为Alist V3 文件夹（不会遍历子文件夹） | `{ host: string, paths: array, ?passwd: string }` | 数组，元素是一个对象，分别有`host`(alist地址)、`paths`(数组，元素是alist文件夹挂载路径)和`passwd`(访问密码)三个属性 |
| AlistV3Pic | 表示类型为Alist V3 文件 | `{ host: string, paths: array, ?passwd: string }` | 数组，元素是一个对象，分别有`host`(alist地址)、`paths`(数组，元素是alist文件路径)和`passwd`(访问密码)三个属性 |

0 comments on commit 84e2112

Please sign in to comment.