INCIDENTES ZERO

API REST

Conteúdos

1. Sobre o Projeto
   • Contruido com
2. API Reference
   • Cadastrar incidente
   • Manutenção de incidente
   • Remoção de incidente
3. Começando
   • Pré-requisitos
   • Instalação
4. Uso
5. Licença
6. Contato

Sobre o Projeto

Esse desafio consiste em criar uma aplicação spring-boot para cadastro de incidentes. A aplicação deverá fornecer operações REST que possibilitem o cadastro/manutenção/remoção de incidentes. Utilizado banco de dados "embeded" (H2) para persistência dos dados e Docker para subir um container do projeto.

Construido com

• Java 11
• Docker
• Spring Boot
• Spring Web MVC
• Spring Data JPA
• Lombok
• H2 DATABASE

API Reference

• Cadastrar incidente

  POST /incidents

  Parameter	Type	Description
  name	string	Required
  description	string	Required

• Manutenção de incidente

  PUT /incidents/${id}

  Parameter	Type	Description
  name	string	Nullable
  description	string	Nullable

• Remoção de incidente

  DELETE /incidents/${id}

Começando

Para obter uma cópia local, siga as etapas seguintes.

Pré-requisitos

• Java 11
• Maven 3.6
• Docker

Instalação

1. Clone o repositório

   $ git clone https://github.com/vrochacaio/IncidenteZero.git
   

2. Instalando com Maven

   $ mvn clean install
   

Uso

1. Rodando o projeto com docker compose

   $ docker compose up -d
   

2. Pronto! Agora faça as requisições através dos Endpoints

License

Distributed under the Apache License 2.0. See LICENSE for more information.

Contato

Caio Rocha - @CODIGO.ROCHA

Project Link: https://github.com/vrochacaio/IncidenteZero