mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
55 lines
3.4 KiB
Markdown
55 lines
3.4 KiB
Markdown
|
---
|
||
|
|
description: "Дополнение изображения до целевого соотношения сторон сплошным цветом, прозрачным или размытым фоном."
|
||
|
|
i18n_source_hash: 796122da3dae
|
||
|
|
i18n_provenance: human
|
||
|
|
i18n_output_hash: 18967f298442
|
||
|
|
---
|
||
|
|
|
||
|
|
# Дополнение изображения {#image-pad}
|
||
|
|
|
||
|
|
Дополняет изображение до целевого соотношения сторон, добавляя вокруг него сплошной цвет, прозрачный или размытый фон. Полезно для подгонки изображений под фиксированные соотношения сторон для соцсетей или печати без обрезки.
|
||
|
|
|
||
|
|
## Конечная точка API {#api-endpoint}
|
||
|
|
|
||
|
|
`POST /api/v1/tools/image/image-pad`
|
||
|
|
|
||
|
|
Принимает данные формы multipart с файлом изображения и полем JSON `settings`.
|
||
|
|
|
||
|
|
## Параметры {#parameters}
|
||
|
|
|
||
|
|
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|
||
|
|
|-----------|------|----------|---------|-------------|
|
||
|
|
| target | string | Нет | `"1:1"` | Целевое соотношение сторон: `16:9`, `9:16`, `1:1`, `4:3`, `3:4` или `custom` |
|
||
|
|
| ratioW | integer | Нет | `1` | Пользовательская ширина соотношения (1-100, используется при target равном `custom`) |
|
||
|
|
| ratioH | integer | Нет | `1` | Пользовательская высота соотношения (1-100, используется при target равном `custom`) |
|
||
|
|
| background | string | Нет | `"color"` | Режим фона: `color`, `transparent` или `blur` |
|
||
|
|
| color | string | Нет | `"#ffffff"` | Фоновый цвет в hex (когда background равен `color`) |
|
||
|
|
| padding | integer | Нет | `0` | Дополнительный отступ в процентах от холста (0-50) |
|
||
|
|
|
||
|
|
## Пример запроса {#example-request}
|
||
|
|
|
||
|
|
```bash
|
||
|
|
curl -X POST http://localhost:1349/api/v1/tools/image/image-pad \
|
||
|
|
-H "Authorization: Bearer si_your-api-key" \
|
||
|
|
-F "file=@photo.jpg" \
|
||
|
|
-F 'settings={"target": "16:9", "background": "blur", "padding": 5}'
|
||
|
|
```
|
||
|
|
|
||
|
|
## Пример ответа {#example-response}
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/photo.jpg",
|
||
|
|
"originalSize": 2450000,
|
||
|
|
"processedSize": 3100000
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Примечания {#notes}
|
||
|
|
|
||
|
|
- Режим фона `blur` создаёт размытую копию исходного изображения в качестве заполнения полей, давая визуально цельный результат.
|
||
|
|
- При использовании фона `transparent` вывод конвертируется в PNG для сохранения альфа-канала.
|
||
|
|
- Выходной формат совпадает с входным, если только не задействована прозрачность. Входные данные HEIC, RAW, PSD и SVG декодируются автоматически перед обработкой.
|
||
|
|
- Установите `target` в `custom` и укажите `ratioW` и `ratioH` для произвольных соотношений сторон (например, `ratioW: 3, ratioH: 2` для 3:2).
|