API - Filmes do Studio Ghibli

SUMÁRIO

Sobre | Ferramentas utilizadas | Dependências | Inicialização | Rotas

⚠️ IMPORTANTE ⚠️

A API está totalmente funcional e você pode testa-la seguindo os passos a seguir, mas ela não está finalizada. A API está em construção e será refatorada em breve.

Sobre a aplicação:

API criada para fins de estudos, para a fixação dos conhecimentos sobre API REST, métodos HTTP, banco de bandos e padrão MVC.

Nessa API são encontrados todos os filmes de longa metragem do estúdio de animação japonês Studio Ghibli.

Informações disponíveis:

• Nome original do filme (em japonês)
• Nome do filme em português
• Ano de lançamento
• Gênero
• Direção
• Produção
• Roteiro

Ferramentas utilizadas

Para o desenvolvimento foi utilizado JavaScript com NodeJS como linguagem da aplicação e o Express como framework.Como bando de dados foi utilizado o SQLite.

O editor de código utilizado foi o VSCode Studio e para testes durante o desenvolvimento foram utilizadas o framework nodemon e o API Design Tool Insomnia.

O Gitemoji também foi utilizado para uma melhor organização e compreensão dos commits.

Dependências

 "dependencies": {
    "express": "^4.17.3",
    "sqlite": "^4.0.25",
    "sqlite3": "^5.0.2"
  },

As dependências podem ser encontradas neste arquivo e para instalar basta rodar o comando abaixo e colar no terminal. Isso criará um clone deste repositório e instalar as dependencias necessárias.

  git clone https://github.com/maysapereira/api-studio-ghibli.git && cd api-studio-ghibli && npm install

Dependências de desenvolvimento

As dependências de desenvolvimento podem ser encontradas neste arquivo. Caso deseje instala-las rode o comando abaixo e cole no terminal logo após o comando das dependencias obrigatórias.

npm install --save-dev nodemon

Inicialização da aplicação:

Para iniciar a aplicação basta abrir o terminal na pasta do projeto ou executar o código abaixo.

npm start

Rotas da aplicação:

[GET] /filmes - A rota exibirá todos os filmes
[GET] /filme/:id - Busca apenas um filme baseado em seu ID
[POST] /filmes - A rota adiciona um novo filme com base nas informações passadas no corpo da requisição.
[PUT] /filmes/:id - A rota atualizará um filme com as informações passadas no corpo da requisição
[DELETE] /filmes/:id - A rota deletará um pedido baseado em seu ID.