Оптимизация изображений

Трансформируйте и оптимизируйте изображения из IPFS на лету с помощью параметров запроса. Это публичная конечная точка, не требующая аутентификации.

Оптимизировать изображение

GET /image/:cid

Возвращает изображение по указанному CID, трансформированное в соответствии с заданными параметрами запроса. Если параметры не указаны, запрос перенаправляется к оригинальному изображению.

Параметры пути

Параметр	Тип	Обязательный	Описание
cid	string	Да	Идентификатор содержимого IPFS изображения.

Параметры запроса

Параметр	Тип	По умолчанию	Описание
w	number	—	Ширина выходного изображения в пикселях. Максимум 4096.
h	number	—	Высота выходного изображения в пикселях. Максимум 4096.
format	string	—	Формат вывода: webp, jpeg, png или avif.
quality	number	80	Качество сжатия, 1-100. Применяется только при установленном format.
fit	string	cover	Способ вписывания изображения в размеры: cover, contain, fill, inside или outside.

Режимы вписывания

Режим	Поведение
cover	Обрезка для заполнения обоих размеров (по умолчанию).
contain	Вписать в оба размера с сохранением пропорций. Может оставить пустое пространство.
fill	Растянуть для точного заполнения обоих размеров. Может исказить изображение.
inside	Как contain, но только уменьшает, никогда не увеличивает.
outside	Как cover, но только уменьшает, никогда не увеличивает.

Примеры запросов

Изменить размер до 400 пикселей в ширину, конвертировать в WebP:

curl "https://api.ipfs.ninja/image/QmXmCX9S6ANV...?w=400&format=webp"

Изменить размер и обрезать до миниатюры 200x200 в формате JPEG с качеством 60%:

curl "https://api.ipfs.ninja/image/QmXmCX9S6ANV...?w=200&h=200&format=jpeg&quality=60&fit=cover"

Использование в HTML

Ссылайтесь на оптимизированные изображения прямо в тегах img:

<img
  src="https://api.ipfs.ninja/image/QmXmCX9S6ANV...?w=800&format=webp&quality=75"
  alt="Optimized IPFS image"
/>

Предоставляйте разные размеры с помощью srcset:

<img
  srcset="
    https://api.ipfs.ninja/image/QmXmCX9S6ANV...?w=400&format=webp 400w,
    https://api.ipfs.ninja/image/QmXmCX9S6ANV...?w=800&format=webp 800w,
    https://api.ipfs.ninja/image/QmXmCX9S6ANV...?w=1200&format=webp 1200w
  "
  sizes="(max-width: 600px) 400px, (max-width: 1000px) 800px, 1200px"
  src="https://api.ipfs.ninja/image/QmXmCX9S6ANV...?w=800&format=webp"
  alt="Responsive IPFS image"
/>

Кэширование

Ответы предоставляются с неизменяемыми заголовками кэширования. Поскольку контент IPFS адресуется по содержимому, один и тот же CID с одинаковыми параметрами всегда даёт одинаковый результат. Браузеры и CDN могут кэшировать эти ответы бессрочно.

Доступность

Оптимизация изображений доступна на всех планах, включая бесплатный план Dharma.