237899745/ystp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(compress): improve quality guardrails and format conversion

Browse Source
This commit is contained in:
yuyx
2026-02-08 00:12:27 +08:00
parent f8955d8a6c
commit 65387ca846
8 changed files with 233 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
frontend/src/pages/DocsPage.vue
View File

@@ -19,7 +19,7 @@
<ul class="mt-2 list-disc space-y-1 pl-5">
<li>Base URL：<code>https://ys.workyai.cn/api/v1</code></li>
<li>认证方式：<code>X-API-Key</code>（推荐）或 <code>Authorization: Bearer &lt;token&gt;</code></li>
<li>支持格式：PNG / JPG / JPEG / WebP / AVIF / GIF（静态）/ BMP / TIFF / ICO</li>
<li>支持格式：PNG / JPG / JPEG / WebP / AVIF / GIF（静态）/ BMP / TIFF / ICO（支持 output_format 转码）</li>
<li>压缩率：<code>compression_rate</code> 1-100，表示压缩后体积占原图比例，100 为不压缩</li>
<li>计量：成功压缩 1 个文件计 1 次；若体积未变小或压缩率为 100，则不扣额度</li>
</ul>
@@ -28,14 +28,15 @@
<div class="rounded-xl border border-slate-200 bg-white p-5 text-sm text-slate-700">
<div class="font-medium text-slate-900">同步压缩（返回 JSON + 下载链接）</div>
<div class="mt-2 text-xs text-slate-500">
<code>POST /compress</code>，表单字段：<code>file</code>、<code>compression_rate</code>、
<code>max_width</code>、<code>max_height</code>、<code>preserve_metadata</code>
<code>POST /compress</code>，表单字段：<code>file</code>、<code>compression_rate</code>/<code>target_size_bytes</code>、
<code>output_format</code>、<code>max_width</code>、<code>max_height</code>、<code>preserve_metadata</code>
</div>
<pre class="mt-3 overflow-auto rounded-lg bg-slate-950 p-4 text-xs text-slate-100"><code>curl -X POST \\
-H \"X-API-Key: if_live_xxx\" \\
-F \"file=@./demo.jpg\" \\
-F \"compression_rate=20\" \\
-F \"max_width=2000\" \\
<pre class="mt-3 overflow-auto rounded-lg bg-slate-950 p-4 text-xs text-slate-100"><code>curl -X POST \
-H "X-API-Key: if_live_xxx" \
-F "file=@./demo.jpg" \
-F "compression_rate=20" \
-F "output_format=webp" \
-F "max_width=2000" \
https://ys.workyai.cn/api/v1/compress</code></pre>
<div class="mt-3 text-xs text-slate-500">
返回字段包含 <code>download_url</code>、<code>saved_percent</code> 与 <code>billing.units_charged</code>。
@@ -45,12 +46,13 @@
<div class="rounded-xl border border-slate-200 bg-white p-5 text-sm text-slate-700">
<div class="font-medium text-slate-900">同步压缩（直接返回二进制）</div>
<div class="mt-2 text-xs text-slate-500">
<code>POST /compress/direct</code>，响应头包含原/压缩大小与扣费信息。
<code>POST /compress/direct</code>，支持同样参数（含 output_format、target_size_bytes），响应头包含原/压缩大小与扣费信息。
</div>
<pre class="mt-3 overflow-auto rounded-lg bg-slate-950 p-4 text-xs text-slate-100"><code>curl -X POST \\
-H \"X-API-Key: if_live_xxx\" \\
-F \"file=@./demo.jpg\" \\
-F \"compression_rate=20\" \\
<pre class="mt-3 overflow-auto rounded-lg bg-slate-950 p-4 text-xs text-slate-100"><code>curl -X POST \
-H "X-API-Key: if_live_xxx" \
-F "file=@./demo.jpg" \
-F "target_size_bytes=120000" \
-F "output_format=jpeg" \
https://ys.workyai.cn/api/v1/compress/direct -o out.jpg -D headers.txt</code></pre>
<div class="mt-3 text-xs text-slate-500">
重点响应头：<code>ImageForge-Original-Size</code>、
@@ -64,16 +66,16 @@
<div class="mt-2 text-xs text-slate-500">
<code>POST /compress/batch</code>，上传多文件后返回任务 ID。
</div>
<pre class="mt-3 overflow-auto rounded-lg bg-slate-950 p-4 text-xs text-slate-100"><code>curl -X POST \\
-H \"X-API-Key: if_live_xxx\" \\
-F \"files[]=@./a.jpg\" \\
-F \"files[]=@./b.jpg\" \\
-F \"compression_rate=30\" \\
<pre class="mt-3 overflow-auto rounded-lg bg-slate-950 p-4 text-xs text-slate-100"><code>curl -X POST \
-H "X-API-Key: if_live_xxx" \
-F "files[]=@./a.jpg" \
-F "files[]=@./b.jpg" \
-F "compression_rate=30" \
https://ys.workyai.cn/api/v1/compress/batch</code></pre>
<div class="mt-3 text-xs text-slate-500">
轮询任务：<code>GET /compress/tasks/&lt;task_id&gt;</code>，响应包含每个文件的 <code>download_url</code> 和 <code>download_all_url</code>（ZIP）。
</div>
<pre class="mt-3 overflow-auto rounded-lg bg-slate-950 p-4 text-xs text-slate-100"><code>curl -H \"X-API-Key: if_live_xxx\" \\
<pre class="mt-3 overflow-auto rounded-lg bg-slate-950 p-4 text-xs text-slate-100"><code>curl -H "X-API-Key: if_live_xxx" \
https://ys.workyai.cn/api/v1/compress/tasks/550e8400-e29b-41d4-a716-446655440200</code></pre>
</div>
@@ -82,10 +84,10 @@
<div class="mt-2 text-xs text-slate-500">
下载地址不在 <code>/api/v1</code> 下，需带同样的认证头。
</div>
<pre class="mt-3 overflow-auto rounded-lg bg-slate-950 p-4 text-xs text-slate-100"><code>curl -H \"X-API-Key: if_live_xxx\" \\
<pre class="mt-3 overflow-auto rounded-lg bg-slate-950 p-4 text-xs text-slate-100"><code>curl -H "X-API-Key: if_live_xxx" \
-L https://ys.workyai.cn/downloads/&lt;file_id&gt; -o result.jpg
curl -H \"X-API-Key: if_live_xxx\" \\
curl -H "X-API-Key: if_live_xxx" \
-L https://ys.workyai.cn/downloads/tasks/&lt;task_id&gt; -o batch.zip</code></pre>
</div>