🚀 STAR WARS API 🚀

Projeto | Tecnologias | Pré-requisitos | Features | Como executar | Endpoints | Author | Licença

💻 Projeto

Este é um projeto para proporcionar dados de Planetas da saga StarWars.

🛠️ Tecnologias

• Go
• Docker
• Gorilla Mux
• MongoDB
• GoDotEnv
• Testify

🧩 Pré-requisitos

Antes de executá-lo, é necessário ter instalado em sua máquina:

• Golang (https://go.dev/);
• Git (https://git-scm.com/);
• Docker (https://www.docker.com/);
• Docker-compose (https://docs.docker.com/compose/);
• Editor de texto (de sua preferência);

📝 Features

• Criar um planeta com Nome, Clima e Terreno.
• Buscar em API externa (https://swapi.dev/api/planets) a quantidade de aparições do respectivo planeta.
• Listar todos os planetas.
• Buscar um planeta por ID.
• Buscar um planeta por Nome.
• Remover um planeta.

⚙️ Como executar

$ git clone https://github.com/flpzow/starwars-api-go
$ cd starwars-api-go

Para iniciá-lo, siga os passos abaixo:

# O projeto sobe aplicação e banco de dados em conteiners Docker.
$ docker-compose up --build

# Para verificar os logs, execute:
$ docker logs nome-do-container

🎯 Endpoints

• CREATE PLANET - /planets (POST)
• LIST PLANETS - /planets (GET)
• GET PLANET BY ID - /planets/{planetId}" (GET)
• GET PLANET BY NAME - /planets?search={name} (GET)
• REMOVE PLANET - /planets/{planetId}" (DELETE)

Exemplo de Payload:

 {

    "name":"Tatooine",
    "climate":"arid",
    "terrain":"desert"
  }

Exemplo de Requisição:

curl -X POST \
  http://localhost:8080/planets \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -d '{
	"name":"Tatooine",
	"climate":"arid",
	"terrain":"desert"
}'

✏️ Author

📝 License

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.