🎬 The Movie API

🎬 Uma API RESTful para gerenciar um catálogo de filmes, integrada à API do The Movie Database (TMDB) para obter informações detalhadas sobre os filmes.

📑 Índice

👀 Visão Geral
🛠️ Tecnologias Utilizadas
⚙️ Funcionalidades
🚀 Como Executar o Projeto
🔒 Autenticação
📌 Tabela de Endpoints
🔗 Endpoints
📝 Documentação da API com Swagger
🧪 Testes
🤝 Contribuições
⭐ Apoie este Projeto
📜 Licença
📞 Contato

👀 Visão Geral

O The Movie API é uma aplicação backend desenvolvida com foco em performance, escalabilidade e organização de código. Integrando-se à poderosa base de dados da TMDB (The Movie Database), esta API permite que usuários gerenciem uma lista personalizada de filmes, incluindo funcionalidades como adicionar à lista de desejos, atualizar o estado (assistido, a assistir, recomendado etc.), registrar avaliações e acompanhar um histórico detalhado de ações. Além disso, a aplicação conta com autenticação básica para segurança, documentação via Swagger, testes automatizados com Vitest e uma arquitetura moderna com Fastify, TypeScript e Prisma.

🛠️ Tecnologias Utilizadas

🟢 Node.js: Plataforma para execução do JavaScript no servidor.
🟦 TypeScript: Superset do JavaScript com tipagem estática.
⚡ Fastify: Framework web de alta performance para Node.js.
🛢️ Prisma: ORM (Object Relational Mapper) para banco de dados.
🗄️ PostgreSQL: Banco de dados relacional utilizado para armazenar informações.
🐳 Docker: Containerização da aplicação.
💎 Zod: Validação de esquemas e dados.
📜 Swagger: Documentação automática da API.
✨ Axios: Cliente HTTP para fazer requisições à API do TMDB.
⚙️ ESLint: Linter para garantir a qualidade do código.
🧪 Vitest: Framework de testes.
🔨 Tsup: Ferramenta para bundling.

⚙️ Funcionalidades

🎥 Adicionar filme à lista de desejos: Adicione um filme à sua lista pessoal.
📄 Listar todos os filmes: Retorne todos os filmes presentes na sua lista, com paginação e filtros.
🔍 Buscar informações de um filme específico: Pesquise informações detalhadas sobre um filme.
🔄 Atualizar o estado de um filme: Alterar o estado de um filme (de "a assistir" para "assistido", por exemplo).
⭐ Avaliar um filme: Dê uma nota para o filme de 0 a 5.
📖 Histórico de ações: Visualize o histórico de ações relacionadas a um filme (adicionado, avaliado, etc).
📊 Logs das requisições: Visualize os logs das requisições feitas na API.

🚀 Como Executar o Projeto

📋 Pré-requisitos

🟩 Node.js 20
📦 npm 10

🔑 Obtenha a sua API Key do TMDB

Antes de acessar a aplicação, é necessário criar uma conta no TMDB e obter uma API Key.

Acesse The Movie Database (TMDB) e crie uma conta.
Após criar a conta, vá até as Configurações da API e gere sua API Key.
Copie essa chave e configure no arquivo .env da aplicação a variável TMDB_API_KEY (veja a seção de instalação para mais detalhes).

🔧 Instalação

Clone o repositório:

git clone https://github.com/joschonarth/the-movie-api.git

Acesse o diretório do projeto:
```
cd the-movie-api
```
Instale as dependências:
```
npm install
```

▶️ Execução

Crie um arquivo .env a partir do exemplo:

O projeto já contém um arquivo .env.example com os exemplos de variáveis de ambiente que você precisa configurar. Copie para .env e preencha as informações de acordo com suas necessidades.
Configure o banco de dados:
- Com Docker:
  
  O projeto utiliza o PostgreSQL como banco de dados. Para rodar o banco de dados localmente via Docker, siga os passos abaixo:
  1. No arquivo .env, configure a URL de conexão para o banco de dados com o seguinte valor:
```
DATABASE_URL="postgresql://docker:docker@localhost:5432/moviedb?schema=public"
```
  2. Em seguida, inicie o banco de dados utilizando a imagem bitnami/postgresql com o comando:
```
docker-compose up movie-api-pg -d
```
  Esse comando irá iniciar o banco de dados em um contêiner Docker com a configuração definida no arquivo docker-compose.yml.
- Com PostgreSQL Local:
  
  Caso você tenha o PostgreSQL instalado localmente, você precisará configurar a variável de ambiente DATABASE_URL com os dados de conexão para o banco de dados. A URL de conexão deve ter o seguinte formato:
```
DATABASE_URL=postgresql://<usuario>:<senha>@localhost:<porta>/<nome_do_banco>
```
  Certifique-se de ajustar <usuario>, <senha>, <porta> e <nome_do_banco> de acordo com a sua configuração.
Execute as migrações do banco de dados:
```
npx prisma migrate dev
```
Rodando a aplicação localmente:

Para rodar a aplicação localmente, execute o seguinte comando:
```
npm run dev
```
A aplicação estará disponível em http://localhost:3333.

🐳 Rodando a aplicação com Docker

Este projeto está containerizado usando o Docker. Para rodar a aplicação em um container Docker, siga os passos abaixo:

Configure a URL de conexão adequada para o container Docker no arquivo .env:

DATABASE_URL=postgresql://docker:docker@movie-api-pg:5432/moviedb?schema=public

Realize a build do projeto com o comando:
```
npm run build
```
Em seguida, utilize o comando abaixo para subir a aplicação no Docker:
```
docker-compose up --build
```

A aplicação estará disponível em http://localhost:3333 dentro do container.

🔒 Autenticação

Todas as rotas da API estão protegidas por Basic Auth. Para autenticação, utilize as seguintes variáveis de ambiente:

ADMIN_USER=admin
ADMIN_PASSWORD=admin123

Se estiver usando uma ferramenta como Postman para testar a API, siga os passos abaixo:

Selecione a requisição desejada.
Vá até a aba de Authorization.
Em Auth Type escolha o método Basic Auth.
Informe o usuário e senha configurados nas variáveis de ambiente.
Envie a requisição normalmente.

Caso esteja utilizando cURL, você pode passar as credenciais da seguinte forma:

curl -u admin:admin123 http://localhost:3333/movie

Caso esteja utilizando httpie, você pode passar as credenciais da seguinte forma:

http -a admin:admin123 http://localhost:3333/movie

📌 Tabela de Endpoints

Método	Rota	Descrição
POST	`/movie`	Adiciona um filme à lista de desejos
GET	`/movie`	Lista todos os filmes
GET	`/movie/:id`	Busca um filme específico
PUT	`/movie/:id/state`	Atualiza o estado do filme
POST	`/movie/:id/rate`	Avalia um filme
GET	`/movie/:id/history`	Histórico de ações do filme
GET	`/log`	Logs de requisições

🔗 Endpoints

🎥 Adicionar Filme à Lista de Desejos

Descrição: Adiciona um filme à lista de desejos.
Método: POST
URL: /movie
Corpo da Requisição:
```
{
  "title": "Interstellar"
}
```

Exemplo de Resposta:

{
  "id": "ae44ae5b-7d56-483a-8283-289c784ee91d",
  "title": "Interstellar",
  "synopsis": "The adventures of a group of explorers who make use of a newly discovered wormhole to surpass the limitations on human space travel and conquer the vast distances involved in an interstellar voyage.",
  "releaseYear": 2014,
  "genre": "Adventure, Drama, Science Fiction",
  "state": "TO_WATCH",
  "createdAt": "2025-04-21T13:41:58.833Z",
  "rating": null
}

📄 Listar Filmes

Descrição: Retorna uma lista de filmes cadastrados. Possui suporte a paginação e filtros.
Método: GET
URL: /movie
Query Params:
- state: Filtra os filmes pelo estado. Pode ser "to_watch", "watched", "rated" "recommended", "no_recommended".
- limit: Define o número máximo de filmes por página. Exemplo: limit=10.
- page: Define a página de busca. Exemplo: page=1.

Exemplo de Requisição:

GET /movie?state=watched&limit=10&page=1

Exemplo de Resposta:

  {
      "data": [
          {
          "id": "ae44ae5b-7d56-483a-8283-289c784ee91d",
          "title": "Interstellar",
          "synopsis": "The adventures of a group of explorers who make use of a newly discovered wormhole to surpass the limitations on human space travel and conquer the vast distances involved in an interstellar voyage.",
          "releaseYear": 2014,
          "genre": "Adventure, Drama, Science Fiction",
          "state": "WATCHED",
          "rating": null,
          "createdAt": "2025-02-09T19:16:02.882Z"
          }
      ],
      "pagination": {
          "limit": 10,
          "currentPage": 1,
          "totalPages": 1,
          "totalItems": 1
      }
  }

🔍 Buscar Filme

Descrição: Busca informações detalhadas de um filme específico.
Método: GET
URL: /movie/:id
Parâmetros de URL:
- id: ID do filme.

Exemplo de Resposta:

{
  "id": "ae44ae5b-7d56-483a-8283-289c784ee91d",
  "title": "Interstellar",
  "synopsis": "The adventures of a group of explorers who make use of a newly discovered wormhole to surpass the limitations on human space travel and conquer the vast distances involved in an interstellar voyage.",
  "releaseYear": 2014,
  "genre": "Adventure, Drama, Science Fiction",
  "state": "TO_WATCH",
  "rating": null,
  "createdAt": "2025-02-09T19:16:02.882Z"
}

🔄 Atualizar o Estado de um Filme

Descrição: Atualiza o estado de um filme (ex: "a assistir" para "assistido").
Método: PUT
URL: /movie/:id/state
Parâmetros de URL:
- id: ID do filme.
Corpo da Requisição:
```
{
  "state": "watched"
}
```

Exemplo de Resposta:

{
  "id": "ae44ae5b-7d56-483a-8283-289c784ee91d",
  "title": "Interstellar",
  "synopsis": "The adventures of a group of explorers who make use of a newly discovered wormhole to surpass the limitations on human space travel and conquer the vast distances involved in an interstellar voyage.",
  "releaseYear": 2014,
  "genre": "Adventure, Drama, Science Fiction",
  "state": "WATCHED",
  "rating": null,
  "createdAt": "2025-02-09T19:16:02.882Z"
}

⭐ Avaliar um Filme

Descrição: Avalia um filme de 0 a 5.
Método: POST
URL: /movie/:id/rate
Parâmetros de URL:
- id: ID do filme.
Corpo da Requisição:
```
{
  "rating": 5
}
```

Exemplo de Resposta:

{
  "id": "ae44ae5b-7d56-483a-8283-289c784ee91d",
  "title": "Interstellar",
  "synopsis": "The adventures of a group of explorers who make use of a newly discovered wormhole to surpass the limitations on human space travel and conquer the vast distances involved in an interstellar voyage.",
  "releaseYear": 2014,
  "genre": "Adventure, Drama, Science Fiction",
  "state": "RATED",
  "rating": 5,
  "createdAt": "2025-02-09T19:16:02.882Z"
}

📖 Histórico do Filme

Descrição: Exibe o histórico de ações de um filme.
Método: GET
URL: /movie/:id/history
Parâmetros de URL:
- id: ID do filme.

Exemplo de Resposta:

{
  "movieId": "ae44ae5b-7d56-483a-8283-289c784ee91d",
  "title": "Interstellar",
  "history": [
    {
      "method": "GET",
      "url": "/movie/ae44ae5b-7d56-483a-8283-289c784ee91d",
      "status": 200,
      "timestamp": "2025-02-09T19:17:32.334Z",
      "user": "a945afc7-f5c3-40ee-a865-94f3623d8c16"
    },
    {
      "method": "PUT",
      "url": "/movie/ae44ae5b-7d56-483a-8283-289c784ee91d/state",
      "status": 200,
      "timestamp": "2025-02-09T19:18:05.061Z",
      "user": "a945afc7-f5c3-40ee-a865-94f3623d8c16"
    },
    {
      "method": "POST",
      "url": "/movie/ae44ae5b-7d56-483a-8283-289c784ee91d/rate",
      "status": 200,
      "timestamp": "2025-02-09T19:18:37.476Z",
      "user": "a945afc7-f5c3-40ee-a865-94f3623d8c16"
    },
    {
      "method": "GET",
      "url": "/movie/ae44ae5b-7d56-483a-8283-289c784ee91d/history",
      "status": 200,
      "timestamp": "2025-02-09T19:19:06.466Z",
      "user": "a945afc7-f5c3-40ee-a865-94f3623d8c16"
    }
  ]
}

📊 Logs das Requisições

Descrição: Exibe os logs de todas as requisições feitas à API.
Método: GET
URL: /log

Exemplo de Resposta:

[
  {
    "id": "971962dd-2ce5-4c27-b3cc-3da71fe9d550",
    "type": "REQUEST",
    "method": "GET",
    "url": "/movie/ae44ae5b-7d56-483a-8283-289c784ee91d/history",
    "status": 200,
    "timestamp": "2025-02-09T19:19:06.466Z",
    "movieId": "ae44ae5b-7d56-483a-8283-289c784ee91d",
    "userId": "a945afc7-f5c3-40ee-a865-94f3623d8c16"
  },
  {
    "id": "1b540827-705a-4ee2-afba-536ef3d91558",
    "type": "REQUEST",
    "method": "POST",
    "url": "/movie/ae44ae5b-7d56-483a-8283-289c784ee91d/rate",
    "status": 200,
    "timestamp": "2025-02-09T19:18:37.476Z",
    "movieId": "ae44ae5b-7d56-483a-8283-289c784ee91d",
    "userId": "a945afc7-f5c3-40ee-a865-94f3623d8c16"
  },
  {
    "id": "261cab53-f903-4d38-8422-b64000017b78",
    "type": "REQUEST",
    "method": "PUT",
    "url": "/movie/ae44ae5b-7d56-483a-8283-289c784ee91d/state",
    "status": 200,
    "timestamp": "2025-02-09T19:18:05.061Z",
    "movieId": "ae44ae5b-7d56-483a-8283-289c784ee91d",
    "userId": "a945afc7-f5c3-40ee-a865-94f3623d8c16"
  },
  {
    "id": "b7f4ca7b-54aa-4e04-9d9d-85682ef065bf",
    "type": "REQUEST",
    "method": "GET",
    "url": "/movie/ae44ae5b-7d56-483a-8283-289c784ee91d",
    "status": 200,
    "timestamp": "2025-02-09T19:17:32.334Z",
    "movieId": "ae44ae5b-7d56-483a-8283-289c784ee91d",
    "userId": "a945afc7-f5c3-40ee-a865-94f3623d8c16"
  },
  {
    "id": "b61a3012-ad80-4f20-9955-815169876a53",
    "type": "REQUEST",
    "method": "GET",
    "url": "/movie",
    "status": 200,
    "timestamp": "2025-02-09T19:16:55.628Z",
    "movieId": null,
    "userId": "a945afc7-f5c3-40ee-a865-94f3623d8c16"
  },
  {
    "id": "e0e7f05d-27d0-465a-82ae-52dbf58142d0",
    "type": "REQUEST",
    "method": "POST",
    "url": "/movie",
    "status": 201,
    "timestamp": "2025-02-09T19:16:02.278Z",
    "movieId": "ae44ae5b-7d56-483a-8283-289c784ee91d",
    "userId": "a945afc7-f5c3-40ee-a865-94f3623d8c16"
  }
]

📝 Documentação da API com Swagger

A documentação da API foi criada utilizando Swagger. Você pode acessá-la em http://localhost:3333/docs após rodar a aplicação.

🧪 Testes

Este projeto utiliza o Vitest para garantir a confiabilidade e o funcionamento correto dos recursos implementados. Para executar os testes, utilize os seguintes comandos:

Executar testes:
```
npm run test
```
Executar testes em modo de observação:
```
npm run test:watch
```
Executar testes com cobertura:
```
npm run test:coverage
```

🤝 Contribuições

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues ou pull requests com melhorias ou correções. ✨

⭐ Apoie este Projeto

Se este projeto te ajudou ou te inspirou de alguma forma, não esqueça de deixar uma ⭐ no repositório! Isso faz toda a diferença! 🚀

📜 Licença

Este projeto está licenciado sob a MIT License.

Name		Name	Last commit message	Last commit date
Latest commit History 66 Commits
prisma		prisma
src		src
.dockerignore		.dockerignore
.env.example		.env.example
.eslintignore		.eslintignore
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
.npmrc		.npmrc
.prettierrc		.prettierrc
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
docker-compose.yml		docker-compose.yml
package-lock.json		package-lock.json
package.json		package.json
start.sh		start.sh
tsconfig.json		tsconfig.json
vitest.config.ts		vitest.config.ts
wait-for-it.sh		wait-for-it.sh

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

🎬 The Movie API

📑 Índice

👀 Visão Geral

🛠️ Tecnologias Utilizadas

⚙️ Funcionalidades

🚀 Como Executar o Projeto

📋 Pré-requisitos

🔑 Obtenha a sua API Key do TMDB

🔧 Instalação

▶️ Execução

🐳 Rodando a aplicação com Docker

🔒 Autenticação

📌 Tabela de Endpoints

🔗 Endpoints

🎥 Adicionar Filme à Lista de Desejos

📄 Listar Filmes

🔍 Buscar Filme

🔄 Atualizar o Estado de um Filme

⭐ Avaliar um Filme

📖 Histórico do Filme

📊 Logs das Requisições

📝 Documentação da API com Swagger

🧪 Testes

🤝 Contribuições

⭐ Apoie este Projeto

📜 Licença

📞 Contato

About

Uh oh!

Releases

Packages

Uh oh!

Languages

License

joschonarth/the-movie-api

Folders and files

Latest commit

History

Repository files navigation

🎬 The Movie API

📑 Índice

👀 Visão Geral

🛠️ Tecnologias Utilizadas

⚙️ Funcionalidades

🚀 Como Executar o Projeto

📋 Pré-requisitos

🔑 Obtenha a sua API Key do TMDB

🔧 Instalação

▶️ Execução

🐳 Rodando a aplicação com Docker

🔒 Autenticação

📌 Tabela de Endpoints

🔗 Endpoints

🎥 Adicionar Filme à Lista de Desejos

📄 Listar Filmes

🔍 Buscar Filme

🔄 Atualizar o Estado de um Filme

⭐ Avaliar um Filme

📖 Histórico do Filme

📊 Logs das Requisições

📝 Documentação da API com Swagger

🧪 Testes

🤝 Contribuições

⭐ Apoie este Projeto

📜 Licença

📞 Contato

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Languages

Packages