mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
75 lines
5.0 KiB
Markdown
75 lines
5.0 KiB
Markdown
|
---
|
||
|
|
description: "Оптимизация изображений для веба с конвертацией формата, управлением качеством, изменением размера и удалением метаданных."
|
||
|
|
i18n_source_hash: c327bbbce768
|
||
|
|
i18n_provenance: human
|
||
|
|
i18n_output_hash: 445ddd340af1
|
||
|
|
---
|
||
|
|
|
||
|
|
# Оптимизация для веба {#optimize-for-web}
|
||
|
|
|
||
|
|
Оптимизация изображений для веб-доставки за один шаг. Объединяет конвертацию формата, настройку качества, опциональное изменение размера, прогрессивное кодирование и удаление метаданных.
|
||
|
|
|
||
|
|
## Эндпоинт API {#api-endpoint}
|
||
|
|
|
||
|
|
`POST /api/v1/tools/image/optimize-for-web`
|
||
|
|
|
||
|
|
Принимает multipart form data с файлом изображения и JSON-полем `settings`.
|
||
|
|
|
||
|
|
Также доступен эндпоинт живого предпросмотра по адресу `POST /api/v1/tools/image/optimize-for-web/preview`, который возвращает обработанное изображение напрямую в двоичном виде (без создания рабочего пространства) для настройки параметров в реальном времени.
|
||
|
|
|
||
|
|
## Параметры {#parameters}
|
||
|
|
|
||
|
|
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|
||
|
|
|-----------|------|----------|---------|-------------|
|
||
|
|
| format | string | Нет | `"webp"` | Выходной формат: `webp`, `jpeg`, `avif`, `png`, `jxl` |
|
||
|
|
| quality | number | Нет | `80` | Качество вывода (1-100) |
|
||
|
|
| maxWidth | number | Нет | - | Максимальная ширина в пикселях. Изображение уменьшается, если шире. |
|
||
|
|
| maxHeight | number | Нет | - | Максимальная высота в пикселях. Изображение уменьшается, если выше. |
|
||
|
|
| progressive | boolean | Нет | `true` | Включить прогрессивное/чересстрочное кодирование |
|
||
|
|
| stripMetadata | boolean | Нет | `true` | Удалить метаданные EXIF, GPS, ICC и XMP |
|
||
|
|
|
||
|
|
## Пример запроса {#example-request}
|
||
|
|
|
||
|
|
```bash
|
||
|
|
curl -X POST http://localhost:1349/api/v1/tools/image/optimize-for-web \
|
||
|
|
-H "Authorization: Bearer si_your-api-key" \
|
||
|
|
-F "file=@photo.jpg" \
|
||
|
|
-F 'settings={"format": "webp", "quality": 75, "maxWidth": 1920}'
|
||
|
|
```
|
||
|
|
|
||
|
|
Оптимизация в AVIF с агрессивным сжатием:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
curl -X POST http://localhost:1349/api/v1/tools/image/optimize-for-web \
|
||
|
|
-H "Authorization: Bearer si_your-api-key" \
|
||
|
|
-F "file=@photo.jpg" \
|
||
|
|
-F 'settings={"format": "avif", "quality": 50, "maxWidth": 1200, "maxHeight": 800}'
|
||
|
|
```
|
||
|
|
|
||
|
|
## Пример ответа {#example-response}
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/photo.webp",
|
||
|
|
"originalSize": 4500000,
|
||
|
|
"processedSize": 320000
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Ответ эндпоинта предпросмотра {#preview-endpoint-response}
|
||
|
|
|
||
|
|
Эндпоинт предпросмотра (`/api/v1/tools/image/optimize-for-web/preview`) возвращает двоичное изображение напрямую с информационными заголовками:
|
||
|
|
|
||
|
|
- `X-Original-Size` - исходный размер файла в байтах
|
||
|
|
- `X-Processed-Size` - размер обработанного файла в байтах
|
||
|
|
- `X-Output-Filename` - URL-кодированное имя выходного файла
|
||
|
|
|
||
|
|
## Примечания {#notes}
|
||
|
|
|
||
|
|
- Этот инструмент спроектирован как единый конвейер оптимизации веб-ресурсов. Он выполняет конвертацию формата, настройку качества, ограничение максимальных размеров и удаление метаданных за один проход.
|
||
|
|
- Расширение имени выходного файла обновляется в соответствии с выбранным форматом.
|
||
|
|
- Кодирование JXL (JPEG XL) использует специализированный CLI-энкодер. Изображение сначала обрабатывается как PNG, затем кодируется в JXL.
|
||
|
|
- Прогрессивное кодирование улучшает воспринимаемое время загрузки для JPEG и PNG, позволяя браузерам отрисовывать предпросмотр низкого качества до полной загрузки изображения.
|
||
|
|
- Эндпоинт предпросмотра легче (без создания рабочего пространства/задания) и предназначен для интерфейса живой настройки параметров во фронтенде.
|