lucasbsimao / starwarsapi

API para pesquisa de informações sobre o universo Star Wars

StarWarsAPI

1. Conceito

Esta API tem como propósito realizar buscas, inclusão e remoção de planetas do universo Star Wars. Estando de acordo com as informações do universo Star Wars original, a API retorna também o número de aparições nos filmes.

2. Dependências

Para executar este projeto são necessárias as seguintes dependências instaladas:

• Java SDK 8;
• Eclipse com Spring Tools Suite 3;
• Mongo DB
• Todas as configurações para funcionamento correto da API são feitas pela aplicação, incluindo a criação do banco no Mongo DB;

Há também a necessidade que o SwAPI esteja online, do contrário a api não conseguirá acessá-lo.

3. Testando a API

A documentação padrão da aplicação é fornecida pelo Swagger. Assim, uma vez que a API estiver online, a documentação estará disponível no endpoint /docApi/swagger-ui.html, como é visto abaixo:

O Swagger também permite fazer testes de requisição. Porém outras aplicações também podem ser utilizadas, como o Postman.

3.1 Lista de funcionalidades

1. Criando um planeta:

Endpoint: /planets/

{
    "name": "Alderaan",
    "climate": "temperate",
    "terrain": "grasslands, mountains"
}

2. Deletando um planeta:

Endpoint: /planets/{id}

3. Listar todos os planetas

Endpoint: /planets/

4. Buscar planeta por id:

Endpoint: /planets/{id}

5. Buscar planeta por nome:

Endpoint: /planets/name/{name}