Api desenvolvida para cuidar dos produtos referentes a mercado da aula de Web.
A Api foi construída em Java de maneira simples para ser utilizada em integração com a aula de web, contendo duas tabelas (Categoria e Produto) no banco de dados Oracle e contendo os principais verbos (GET, POST, PUT, DELETE).
A Api foi dividida em camadas, de forma que as requisições HTTP são recebidas pelas Classes contidas no pacote Resource, então o Resource encaminha as devidas solicitações para a camada Service que irá aplicar as regras de negócio e as relações para logo em seguida encaminhar a solicitação para a camada Dao. Na camada Dao é feita a parte de interação com o banco de dados Oracle, onde irá ocorrer os SELECTS, INSERTS e afins. Para as explicações das camadas e pacotes, será utilizado como exemplo a Categoria, uma vez que ela contêm menos atributos e sua codificação é um pouco mais simplificada em relação a Produto, facilitando a explicação.
Para que a camada Dao consiga realizar as interações com o banco de dados, ela utiliza os modelos dos objetos em questão, contendo os atributos que serão encontrados no banco de dados. Para simplificação do código dos modelos, foi utilizada a biblioteca Java chamada Lombok, tornando possível a criação dos getters, setters e toString por meio de Annotations.
Camada responsável pelo acesso dos dados no banco de dados Oracle, contendo variáveis privadas que armazenam os Statements utilizados nas funções. As funções que contêm no Dao são as de cadastrar, listar os itens do banco, procurar um item pelo id, atualizar e deletar. A seguir um exemplo tanto da variável quanto da função:
A camada Service fica responsável por aplicar as relações, regras de negócio e algumas verificações que irão assegurar a integridade do banco e de suas informações. Como exemplo será mostrada a função atualizar que verifica se as informações recebidas em JSON, veio alguma nula ou contrária a regras do banco e, caso necessário, lança a exceção. Também é nessa camada que se tem contato com a Factory responsável por obter a conexão com o banco.
É nessa camada que são recebidas as requisições HTTP e então, conforme as regras de funcionamento da api, são produzidas e consumidas as informações. Caso em algum momento seja lançado uma exceção, é aqui que é devolvida a respectiva resposta com seu devido código.
Em alguns momentos se tornou interessante a criação de uma Exception que representasse melhor o erro que ocorreu, para assim, retornar de forma mais assertiva o motivo da falha pra quem fez o request na api. Onde a BadInfoException foi utilizada, principalmente, quando um dado foi encaminhado de maneira incorreta ou nula e isso geraria um problema no banco. Já a IdNotFoundException foi utilizada para requisições que em algum momento seria necessária a busca de um item no banco pelo seu id, e o id informado não foi localizado no banco.
Foi criado esse pacote para conter a ConnectionFactory que fica responsável por coletar as credenciais do banco e criar a conexão para ser utilizada pela Api.
A interface aqui funciona como um contrato para garantir que os Daos estão implementando os métodos conforme especificado nela, contendo os tipos de retorno, argumentos e lançamentos de exceções.
Na pasta SQL do repositório contem os scripts DDL e DML, onde serão criadas as tabelas utilizadas na api e populando-as caso seja desejado na hora de testar a api.
