/recipe-api

Primary LanguageTypeScript

Recipe API

https://edjdc.github.io/recipe-api

Utilização

Para executar a aplicação é necessário ter o docker e o docker-compose instalados.

Execute o comando docker-compose up --build para iniciar a aplicação.

Após a aplicação tiver sido iniciada é possível acessar o link http://localhost:8080/recipes/ para realizar consultar na API.

Endpoints:

GET /health - Retorna o status da aplicação

GET /metrics - Retorna métricas da aplicação

GET /recipes/?i={ingredient_1},{ingredient_2},{ingredient_3} - Retorna as receitas para os ingredientes informados (máximo 3)

Desenvolvimento

Para executar a aplicação localmente é necessário criar um arquivo .env na raiz do projeto com uma variável GIPHY_API_KEY preenchida com um token de acesso da API do giphy.

O arquivo docker-compose.yml possui um token que pode ser utilizado para testes.

Comandos

Install

yarn install

Start

yarn start

Start - prod

yarn start:prod

Build

yarn build

Tests

yarn test

Tests - coverage

yarn test:coverage

Prettier - format

yarn prettier:format

Prettier - check

yarn prettier:check

Lint

yarn lint