# tinyimg

**Repository Path**: napasa/tinyimg

## Basic Information

- **Project Name**: tinyimg
- **Description**: tinyimg是一个专注于图片压缩的开源免费网站，该仓库为tinypng网站的开发目录。
- **Primary Language**: NodeJS
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2020-01-23
- **Last Updated**: 2020-12-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# tinyimg

## Description
tinyimg是一个专注于图片压缩,图片处理等批量图片文件处理业务的开源免费网站，该仓库为tinyimg网站的开发目录。

## API文档
### 上传文件
http://host/compress/upload

方法:POST

参数:
参数 | 是否必须 |  说明  
-|-|-
file | 是 | 文件数组，即用户上传的文件 |
jpgmode | 是 | 压缩jpg的模式(quality/upsize)|
factor | 是 |当jpgmode为quality时,factor为压缩质量(0~100),当jpgmode为upsize时，factor为压缩后jpg文件不大于该大小(单位kb) 默认65 |
pixel | 是 | 压缩后的jpg文件的像素尺寸,默认为origin|
depth | 是 | 压缩后的jpg文件的深度(1/2/4/8/16/32/origin) |
gray | 是 | 压缩后的jpg文件是否为灰度图(true/false),默认为false|
colors | 是 | 压缩后的png文件的颜色数(2/4/8/16/32/64/128/256/origin),默认为origin|
dither | 是 | 压缩后的png文件是否去噪(true/false),默认为true|

返回:
参数 | 是否必须 |  说明  
-|-|-
code | 是 | code=0代表无错误发生，其余代表有错误 |
stamp | 是 | 代表本次上传的文件戳，用于查询压缩结果 |
status | 是 | 文件状态,返回值为converting |


### 查询结果
http://host/compress/status


方法:GET

参数:
参数 | 是否必须 |  说明  
-|-|-
stamp | 是 | 文件戳，用于查询压缩结果 |

返回:
参数 | 是否必须 |  说明  
-|-|-
code | 是 | code=0代表无错误发生，其余代表有错误 |
status | 是 | 该戳所代表的文件的状态值，有converting,success |
newSize | 否 | 新文件大小,单位kb。当status为success时有该值 |
oldSize | 否 | 旧文件大小,单位kb。当status为success时有该值 |
delteTime | 否 | 新文件，旧文件将于该时间戳代表的时间删除。当status为success时有该值 |
originalName| 否 | 用户上传的文件的原文件名 |

### 查询结果
http://host/compress/download
方法:GET

参数:
参数 | 是否必须 |  说明  
-|-|-
stamp | 是 | 文件戳，用于下载压缩结果 |

返回:
正常情况下下载文件。否则返回如下结构体
参数 | 是否必须 |  说明  
-|-|-
code | 是 | code=0代表无错误发生，其余代表有错误 |
msg | 是 | 该错误的含义 |


### 前端与设计要求
 体验并使用[tinypng](https://tinypng.com/)的功能，设计一版图片压缩网站，仅有上传，转换，下载功能的图片压缩网站，前端并跟进开发。

 ### 后端要求
 根据API文档，及时给出接口以供前端开发测试

 ### SEO要求
待网站开发完毕，跟进seo

#### Contribution

1.  Fork the repository
2.  Create Feat_xxx branch
3.  Commit your code
4.  Create Pull Request


#### Gitee Feature

1.  You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
2.  Gitee blog [blog.gitee.com](https://blog.gitee.com)
3.  Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
4.  The most valuable open source project [GVP](https://gitee.com/gvp)
5.  The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
6.  The most popular members  [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)