Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.11 KB

README.md

File metadata and controls

42 lines (29 loc) · 1.11 KB

Visão Geral

Essa API tem como objetivo gerar imagens a partir de mensagens de conselhos "advices" fornecidas por outra api disponivel neste site.

Existem dois endpoints disponíveis:

GET /advice: Gera uma imagem com um conselho aleatório.
GET /advice/:id: Gera uma imagem com o conselho correspondente ao ID fornecido.

Endpoints

GET /advice

Esse endpoint gera uma imagem com um conselho aleatório.

Parâmetros

Não há parâmetros para este endpoint.

Resposta

Corpo da Resposta Um arquivo PNG contendo a imagem com o conselho.


GET /advice/:id Esse endpoint gera uma imagem com o conselho correspondente ao ID fornecido.

Parâmetros

id: O ID do conselho a ser gerado.

Resposta

Corpo da Resposta Um arquivo PNG contendo a imagem com o conselho.

Bibliotecas utilizadas

express: Framework web para Node.js.

jimp: Biblioteca para manipulação de imagens em Node.js.

Rotinas Utilizadas

findAdviceById(id: number) Encontra um conselho por ID. randomAdvice() Encontra um conselho aleatório.