Skip to content

wmr049/goku-api-service

Repository files navigation

API Cadastro de Gerenciamento ecom GOKU

Descrição

Uma simples API que simula um cadastro básico de usuario e busca de endereços.

Funcionalidades

  • Cadastrar cliente;
  • Cadastrar Estado e Cidade;
  • Cadastrar endereço apartir de uma chamada por CEP
  • Remover cliente;
  • Editar cliente;
  • Buscar clientes e cidades;

Powered By

  • Spring Boot 2.4.2;
  • Postgree;
  • FlyWay (migrations);
  • Swagger;
  • Java 11;

Swagger, Endpoints e Login

A API dispõe de acesso ao Swagger para fácil utilização. Após subir o serviço, acesse http://localhost:8080/swagger-ui.html.

Os endpoints disponíveis estão presentes nele.

Para todos os endpoints (exceto o "Swagger-UI"), um token JWT é necessário. Para a maioria das operações de criação, remoção e edição, o usuário deve ter permissão de administrador.

Faça uma requisição POST para /login, com o body JSON:

    {
        "email": "email@email.com",
        "password": "password"
    }

Se o e-mail e a senha forem válidos, o token JWT será devolvido no header "Authorization" da response.

Para o primeiro login, verifique "Usuário e Senha para o Primeiro Login".

Dados de Testes

A aplicação cria alguns dados para testes, caso o banco de dados estiver vazio.

São dois usuários, 2 cidades e 2 Estados.

Usuário e Senha para o Primeiro Login

Comum

    {
        "email": "usuario@usuario.com.br",
        "password": "123456"
    }

Administrador

    {
        "email": "admin@admin.com.br",
        "password": "123456"
    }

Tabelas e Migrations

As tabelas usadas pelo MySQL estão no arquivo ./src/main/resources/db/migration. Usamos o FlyWay para criar as tabelas no banco e versionar as migrations. O Hibernate não cria ou atualiza as tabelas.

Testes

Executar os testes que se encontram dentro do modulo de teste.

Ao executá-los, a aplicação utilizará um segundo banco de dados (o H2 in-memory), independente do MySQL principal, mas que terá o mesmo schema.

O arquivo ./src/test/resources/application.yml gerencia a conexão dos testes com o H2.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages