PokeCardApi

Instalação

Para iniciar a aplicação, siga as etapas abaixo, dependendo se você está usando Docker ou não.

No diretório raiz do projeto, execute o seguinte comando para instalar as dependências do projeto:

npm install

Com Docker (Recomendado)

Se você deseja executar a aplicação com Docker, siga as etapas abaixo:

Execute o seguinte comando para construir e iniciar os contêineres Docker em segundo plano:

docker-compose up -d

Após os contêineres estarem em execução. Execute o seguinte comando para entrar no contêiner:

docker-compose exec app sh

Você precisará popular o banco de dados dentro do contêiner gerado Execute o seguinte comando dentro do contêiner::

npm run seed

Sem o Docker

Se você preferir executar a aplicação sem Docker, siga estas etapas:

Execute o seguinte comando para criar o banco de dados e popular com dados iniciais:

npm run createdb

Inicie o servidor com o seguinte comando:

npm start

Tecnologias Utilizadas

Node.js
Express
SQL (Banco de Dados)
TypeScript
Docker (para containerização)

Visão Geral

Este projeto oferece uma API construída com Node.js e Express para gerenciar um banco de dados SQL. A aplicação inclui recursos para registro e autenticação de usuários, gerenciamento de cartas e decks. A seguir, você encontrará informações detalhadas sobre as rotas disponíveis e como utilizá-las.

Uso

Este README contém informações detalhadas sobre as rotas da aplicação e como usá-las. Cada seção individual descreve uma rota específica, incluindo o método HTTP, a URL, o corpo da solicitação, a resposta e exemplos de uso. Consulte as seções a seguir para obter informações completas.

Rota de Login
Rota de Registro
Rota de Pegar Cartas
Rota de Deletar Carta
Rota de Ganhar Carta
Rota de Pegar Decks
Rota de Pegar Deck
Rota de Deletar Deck
Rota de Criar Deck

Rota de Login

Descrição

A Rota de Login permite que os usuários registrados acessem suas contas fornecendo suas credenciais de usuário.

Método HTTP: POST
URL: /login/

Corpo da Solicitação (Request Body)

{
  "userName": "seu-nome-de-usuário",
  "password": "sua-senha-secreta"
}

Exemplo de Resposta (Response)

Status: 200 (OK)

Rota de Registro

Descrição

A Rota de Registro permite que novos usuários se cadastrem na aplicação fornecendo informações como nome de usuário e senha.

Método HTTP: POST
URL: /login/register/

Corpo da Solicitação (Request Body)

{
  "userName": "novo-nome-de-usuário",
  "password": "nova-senha-secreta"
}

Exemplo de Resposta (Response)

Status: 201 (Created)

Rota de Pegar Cartas

Descrição

A Rota de Pegar Cartas permite que você obtenha as cartas associadas a um usuário específico com base no userId.

Método HTTP: GET
URL: /card/:userId

Exemplo de Uso

A Rota de Pegar Cartas é usada para recuperar as cartas pertencentes a um usuário com base em seu userId. Aqui está um exemplo de uso:

Solicitação:

GET /card/123 HTTP/1.1
Host: http://localhost:3001

Exemplo de Resposta

Status: 200 (OK)

[
  {
    "id": 1,
    "name": "bulbasaur",
    "attack": 50,
    "hp": 100,
    "spriteOnBoard": "sprite1-board.png",
    "spriteOnCard": "sprite1-card.png",
    "types": "grass_poison"
  },
  {
    "id": 2,
    "name": "charmander",
    "attack": 80,
    "hp": 80,
    "spriteOnBoard": "sprite1-board.png",
    "spriteOnCard": "sprite1-card.png",
    "types": "fire"
  },
  {
    "id": 3,
    "name": "squitle",
    "attack": 40,
    "hp": 140,
    "spriteOnBoard": "sprite1-board.png",
    "spriteOnCard": "sprite1-card.png",
    "types": "water"
  },
  {
    "id": 4,
    "name": "pikachu",
    "attack": 60,
    "hp": 100,
    "spriteOnBoard": "sprite1-board.png",
    "spriteOnCard": "sprite1-card.png",
    "types": "electric"
  },
  {
    "id": 5,
    "name": "pidgey",
    "attack": 50,
    "hp": 100,
    "spriteOnBoard": "sprite1-board.png",
    "spriteOnCard": "sprite1-card.png",
    "types": "normal_flying"
  },
  {
    "id": 6,
    "name": "ratata",
    "attack": 50,
    "hp": 100,
    "spriteOnBoard": "sprite1-board.png",
    "spriteOnCard": "sprite1-card.png",
    "types": "normal"
  },
  {
    "id": 9,
    "name": "squitle",
    "attack": 40,
    "hp": 140,
    "spriteOnBoard": "sprite1-board.png",
    "spriteOnCard": "sprite1-card.png",
    "types": "water"
  }
]

Rota de Deletar Carta

Descrição

A Rota de Deletar Carta permite que você exclua uma carta específica pertencente a um usuário com base no userId e cardId.

Método HTTP: DELETE
URL: /card/:userId/:cardId

Exemplo de Resposta (Response)

Status: 200 (OK)

Exemplo de Uso

A Rota de Deletar Carta é usada para excluir uma carta específica de um usuário. Você deve especificar o userId e o cardId na URL para identificar a carta que deseja excluir. Aqui está um exemplo de uso:

Solicitação:

DELETE /card/123/456 HTTP/1.1
Host: http://localhost:3001

Rota de Ganhar Carta

Descrição

A Rota de Ganhar Carta permite que você registre uma nova carta que um usuário ganhou em sua coleção.

Método HTTP: POST
URL: /:userId

Corpo da Solicitação (Request Body)

{
  "name": "Nome da Carta",
  "Attack": 10,
  "Hp": 20,
  "spriteOnBoard": "caminho-da-imagem",
  "spriteOnCard": "caminho-da-imagem",
  "types": "Tipo da Carta"
}

Exemplo de Resposta (Response)

Status: 200 (Created)

Solicitação:

POST /card/123 HTTP/1.1
Host: http://localhost:3001

Rota de Pegar Decks

Descrição

A Rota de Pegar Decks permite que você obtenha todos os decks associados a um usuário com base no userId.

Método HTTP: GET
URL: /deck/:userId

Exemplo de Resposta

Status: 200 (OK)

[
  {
    "deck": {
      "id": 1,
      "name": "test"
    },
    "cards": [
      {
        "id": 1,
        "name": "bulbasaur",
        "attack": 50,
        "hp": 100,
        "spriteOnBoard": "sprite1-board.png",
        "spriteOnCard": "sprite1-card.png",
        "types": "grass_poison"
      },
      {
        "id": 2,
        "name": "charmander",
        "attack": 80,
        "hp": 80,
        "spriteOnBoard": "sprite1-board.png",
        "spriteOnCard": "sprite1-card.png",
        "types": "fire"
      },
      {
        "id": 3,
        "name": "squitle",
        "attack": 40,
        "hp": 140,
        "spriteOnBoard": "sprite1-board.png",
        "spriteOnCard": "sprite1-card.png",
        "types": "water"
      },
      {
        "id": 4,
        "name": "pikachu",
        "attack": 60,
        "hp": 100,
        "spriteOnBoard": "sprite1-board.png",
        "spriteOnCard": "sprite1-card.png",
        "types": "electric"
      },
      {
        "id": 5,
        "name": "pidgey",
        "attack": 50,
        "hp": 100,
        "spriteOnBoard": "sprite1-board.png",
        "spriteOnCard": "sprite1-card.png",
        "types": "normal_flying"
      },
      {
        "id": 6,
        "name": "ratata",
        "attack": 50,
        "hp": 100,
        "spriteOnBoard": "sprite1-board.png",
        "spriteOnCard": "sprite1-card.png",
        "types": "normal"
      }
    ]
  },
  {
    "deck": {
      "id": 2,
      "name": "a"
    },
    "cards": [
      {
        "id": 1,
        "name": "bulbasaur",
        "attack": 50,
        "hp": 100,
        "spriteOnBoard": "sprite1-board.png",
        "spriteOnCard": "sprite1-card.png",
        "types": "grass_poison"
      },
      {
        "id": 2,
        "name": "charmander",
        "attack": 80,
        "hp": 80,
        "spriteOnBoard": "sprite1-board.png",
        "spriteOnCard": "sprite1-card.png",
        "types": "fire"
      },
      {
        "id": 3,
        "name": "squitle",
        "attack": 40,
        "hp": 140,
        "spriteOnBoard": "sprite1-board.png",
        "spriteOnCard": "sprite1-card.png",
        "types": "water"
      },
      {
        "id": 4,
        "name": "pikachu",
        "attack": 60,
        "hp": 100,
        "spriteOnBoard": "sprite1-board.png",
        "spriteOnCard": "sprite1-card.png",
        "types": "electric"
      },
      {
        "id": 5,
        "name": "pidgey",
        "attack": 50,
        "hp": 100,
        "spriteOnBoard": "sprite1-board.png",
        "spriteOnCard": "sprite1-card.png",
        "types": "normal_flying"
      },
      {
        "id": 6,
        "name": "ratata",
        "attack": 50,
        "hp": 100,
        "spriteOnBoard": "sprite1-board.png",
        "spriteOnCard": "sprite1-card.png",
        "types": "normal"
      }
    ]
  }
]

Exemplo de Uso

A Rota de Pegar Decks é usada para recuperar todos os decks pertencentes a um usuário com base em seu userId. Aqui está um exemplo de uso:

Solicitação:

GET /deck/123 HTTP/1.1
Host: http://localhost:3001

Rota de Pegar Deck

Descrição

A Rota de Pegar Deck permite que você obtenha as cartas que estão associadas a um deck específico pertencente a um usuário com base no userId e deckId.

Método HTTP: GET
URL: /deck/:userId/:deckId

Exemplo de Resposta

Status: 200 (OK)

{
  "deck": {
    "id": 1,
    "name": "test"
  },
  "cards": [
    {
      "id": 1,
      "name": "bulbasaur",
      "attack": 50,
      "hp": 100,
      "spriteOnBoard": "sprite1-board.png",
      "spriteOnCard": "sprite1-card.png",
      "types": "grass_poison"
    },
    {
      "id": 2,
      "name": "charmander",
      "attack": 80,
      "hp": 80,
      "spriteOnBoard": "sprite1-board.png",
      "spriteOnCard": "sprite1-card.png",
      "types": "fire"
    },
    {
      "id": 3,
      "name": "squitle",
      "attack": 40,
      "hp": 140,
      "spriteOnBoard": "sprite1-board.png",
      "spriteOnCard": "sprite1-card.png",
      "types": "water"
    },
    {
      "id": 4,
      "name": "pikachu",
      "attack": 60,
      "hp": 100,
      "spriteOnBoard": "sprite1-board.png",
      "spriteOnCard": "sprite1-card.png",
      "types": "electric"
    },
    {
      "id": 5,
      "name": "pidgey",
      "attack": 50,
      "hp": 100,
      "spriteOnBoard": "sprite1-board.png",
      "spriteOnCard": "sprite1-card.png",
      "types": "normal_flying"
    },
    {
      "id": 6,
      "name": "ratata",
      "attack": 50,
      "hp": 100,
      "spriteOnBoard": "sprite1-board.png",
      "spriteOnCard": "sprite1-card.png",
      "types": "normal"
    }
  ]
}

Exemplo de Uso

A Rota de Pegar Deck é usada para recuperar as cartas que estão associadas a um deck específico pertencente a um usuário. Você deve especificar o userId e o deckId na URL para identificar o deck desejado. Aqui está um exemplo de uso:

Solicitação:

GET /deck/123/456 HTTP/1.1
Host: http://localhost:3001

Rota de Deletar Deck

Descrição

A Rota de Deletar Deck permite que você exclua um deck específico pertencente a um usuário com base no userId e deckId.

Método HTTP: DELETE
URL: /deck/:userId/:deckId

Exemplo de Resposta (Response)

Status: 200 (OK)

Exemplo de Uso

A Rota de Deletar Deck é usada para excluir um deck específico de um usuário. Você deve especificar o userId e o deckId na URL para identificar o deck que deseja excluir. Aqui está um exemplo de uso:

Solicitação:

DELETE /deck/123/456 HTTP/1.1
Host: http://localhost:3001

Exemplo de Resposta (Response)

Status: 200 (OK)

Rota de Criar Deck

Descrição

A Rota de Criar Deck permite que um usuário crie um novo deck em sua coleção.

Corpo da Solicitação (Request Body)

{
  "name": "Nome do Deck",
  "cards": [
    {
      "id": 1,
      "name": "Nome da Carta",
      "hp": 20,
      "attack": 10,
      "spriteOnBoard": "caminho-da-imagem",
      "spriteOnCard": "caminho-da-imagem",
      "types": "Tipo da Carta"
    },
    // Outras cartas do deck
  ]
}

Exemplo de Resposta (Response)

Status: 201 (Created)

Exemplo de Uso

A Rota de Criar Deck é usada para adicionar um novo deck à coleção de um usuário. Você deve especificar o userId na URL e fornecer os detalhes do novo deck no corpo da solicitação, incluindo as cartas que farão parte do deck. Aqui está um exemplo de uso:

Solicitação

POST /deck/123 HTTP/1.1
Host: http://localhost:3001

Corpo da Solicitação (Request Body)

{
  "name":"initialDeck",
  "cards": [
    {
      "id": 1,
      "name": "bulbasaur",
      "attack": 50,
      "hp": 100,
      "spriteOnBoard": "sprite1-board.png",
      "spriteOnCard": "sprite1-card.png",
      "types": "grass_poison"
    },
    {
      "id": 2,
      "name": "charmander",
      "attack": 80,
      "hp": 80,
      "spriteOnBoard": "sprite1-board.png",
      "spriteOnCard": "sprite1-card.png",
      "types": "fire"
    },
    {
      "id": 3,
      "name": "squitle",
      "attack": 40,
      "hp": 140,
      "spriteOnBoard": "sprite1-board.png",
      "spriteOnCard": "sprite1-card.png",
      "types": "water"
    },
    {
      "id": 4,
      "name": "pikachu",
      "attack": 60,
      "hp": 100,
      "spriteOnBoard": "sprite1-board.png",
      "spriteOnCard": "sprite1-card.png",
      "types": "electric"
    },
    {
      "id": 5,
      "name": "pidgey",
      "attack": 50,
      "hp": 100,
      "spriteOnBoard": "sprite1-board.png",
      "spriteOnCard": "sprite1-card.png",
      "types": "normal_flying"
    },
    {
      "id": 6,
      "name": "ratata",
      "attack": 50,
      "hp": 100,
      "spriteOnBoard": "sprite1-board.png",
      "spriteOnCard": "sprite1-card.png",
      "types": "normal"
    }
  ]
}

Name		Name	Last commit message	Last commit date
Latest commit History 26 Commits
.nyc_output		.nyc_output
config		config
controller		controller
migrations		migrations
models		models
routes		routes
seeders		seeders
services		services
tests		tests
types		types
.dockerignore		.dockerignore
.env		.env
.gitignore		.gitignore
.sequelizerc		.sequelizerc
Dockerfile		Dockerfile
app.ts		app.ts
docker-compose.yml		docker-compose.yml
package-lock.json		package-lock.json
package.json		package.json
readme.md		readme.md
server.ts		server.ts
tsconfig.json		tsconfig.json

JoaoRViana/pokeCardApi

Folders and files

Latest commit

History

Repository files navigation

PokeCardApi

Instalação

Com Docker (Recomendado)

Sem o Docker

Tecnologias Utilizadas

Visão Geral

Uso

Rota de Login

Descrição

Corpo da Solicitação (Request Body)

Exemplo de Resposta (Response)

Rota de Registro

Descrição

Corpo da Solicitação (Request Body)

Exemplo de Resposta (Response)

Rota de Pegar Cartas

Descrição

Exemplo de Uso

Rota de Deletar Carta

Descrição

Exemplo de Resposta (Response)

Exemplo de Uso

Rota de Ganhar Carta

Descrição

Corpo da Solicitação (Request Body)

Exemplo de Resposta (Response)

Rota de Pegar Decks

Descrição

Exemplo de Uso

Rota de Pegar Deck

Descrição

Exemplo de Uso

Rota de Deletar Deck

Descrição

Exemplo de Resposta (Response)

Exemplo de Uso

Exemplo de Resposta (Response)

Rota de Criar Deck

Descrição

Corpo da Solicitação (Request Body)

Exemplo de Resposta (Response)

Exemplo de Uso

Solicitação

Corpo da Solicitação (Request Body)

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Contributors 2

Languages

Packages