A API foi definida e documentada para melhor entendimento da sua utilização através da linguagem de modelagem RAML (RESTful API Modeling Language).

Para consultar a definição acesse o arquivo products.raml utilizando a ferramenta de sua preferência.

A API foi desenvolvida em uma arquitetura REST para permitir uma fácil integração a outros sistemas e também visando escalabilidade, manutenibilidade e extensibilidade.

A arquitetura está projetada para possibilitar uma fácil evolução do seu projeto e a utilização de qualquer tipo de implementação de persistência de dados.

Visando testabilidade e praticidade na evolução, o projeto possui configuração para cobertura de testes unitários para serviços, repositórios de dados e serviços WEB com massa de dados independente permitindo alterações e refatorações seguras respaldadas nos testes.

• Oracle Java 8
• Apache Maven
• Spring Framework
• HSQLDB

A API roda em um Container WEB Java (Tomcat) e um banco de dados (HSQLDB) embutidos, portanto não necessita de instalação de nenhum container ou banco de dados.

É necessário apenas ter o Oracle JDK 8+ e Apache Maven 3+ instalados e configurados no PATH da máquina.

Para construir e distribuir a aplicação execute o seguinte comando na pasta products-api:

mvn clean package && java -jar target/products-api.jar

Neste momento a suite de testes unitários também é executada para garantir a integridade da aplicação.

Após a construção e distribuição da aplicação a API estará disponível para acesso no seguinte endereço:

http://localhost:8080/products/

Formato JSON:

{
    "id" : 1,
	"name" : "test name",
    "description" : "test description",
    "price" : 100.00,
    "category" : "test category"
}

Como a API produz e consome dados no formato JSON, o acesso diretamente pelo navegador não funcionará para todos os recursos.

É recomendado utilizar alguma ferramenta utilitária de comunicação HTTP como cURL ou Postman para efetuar as chamadas aos recursos.

Está sendo disponibilizado o arquivo Products.postman_collection que contém exemplos de chamadas aos recursos e que pode ser importado na ferramenta Postman.

Para executar a suite de testes unitários execute o seguinte comando:

mvn clean test