Skip to main content

Imagens

Upload file​

POST
/upload/image
Autenticação via cookies

Endpoint para upload de imagens (exclusivamente). Espera o header multipart/form-data na request. Este endpoint otimiza imagens utilizando conversão para webp, e pode receber opções de qualidade.

Request

type ImageUploadData = {
    quality?: number
    meta?: string
}

Metadados podem ser enviados opcionalmente e serão armazenados em formato de string. Para enviar objetos basta utilizar JSON.stringify. A propriedade quality é um número que especifica a qualidade com a qual a imagem será salva. Precisa ser um número entre 1 e 100. Padrão, caso não especificado: 40. Em boa parte dos casos o 40 já irá servir. Recomendo aumentar em casos de ser uma imagem grande e importante para a página. A biblioteca utilizada para otimização de imagens é chamada sharp.

Caso qualquer uma das regras não seja seguida, uma mensagem de erro explicativa será retornada.

Estas imagens são servidas de forma estática, ou seja, basta armazenar sua URL, que é a URL do serviço S3 + o caminho retornado.

Response

Status: 200
type ImageUploadResponse = {
    file: {
        id: string
        type: string
        path: string
        meta?: string
        createdAt: Date
    }
}