{"id":19623753,"url":"https://github.com/jvitoralb/dio-lab-rest-api","last_synced_at":"2026-04-20T10:32:38.545Z","repository":{"id":202847688,"uuid":"708256450","full_name":"jvitoralb/dio-lab-rest-api","owner":"jvitoralb","description":"Uma REST API desenvolvida com Spring Framework em Java e PostgreSQL para um Bootcamp da DIO com o Santander.","archived":false,"fork":false,"pushed_at":"2024-12-05T21:37:56.000Z","size":134,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-16T08:57:55.324Z","etag":null,"topics":["java","postgresql","rest-api","spring-boot","springframework"],"latest_commit_sha":null,"homepage":"https://dio-lab-rest-api-production.up.railway.app/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jvitoralb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-22T02:01:31.000Z","updated_at":"2024-12-05T21:38:00.000Z","dependencies_parsed_at":"2023-10-27T16:26:11.412Z","dependency_job_id":"512cf153-5e07-49b7-9bb3-6c3f76dc135b","html_url":"https://github.com/jvitoralb/dio-lab-rest-api","commit_stats":null,"previous_names":["jvitoralb/dio-lab-rest-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jvitoralb/dio-lab-rest-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jvitoralb%2Fdio-lab-rest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jvitoralb%2Fdio-lab-rest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jvitoralb%2Fdio-lab-rest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jvitoralb%2Fdio-lab-rest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jvitoralb","download_url":"https://codeload.github.com/jvitoralb/dio-lab-rest-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jvitoralb%2Fdio-lab-rest-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32043028,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T00:18:06.643Z","status":"online","status_checked_at":"2026-04-20T02:00:06.527Z","response_time":94,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","postgresql","rest-api","spring-boot","springframework"],"created_at":"2024-11-11T11:35:20.134Z","updated_at":"2026-04-20T10:32:38.529Z","avatar_url":"https://github.com/jvitoralb.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Biblioteca API\r\n\r\n- [Sobre](#sobre)\r\n- [Como Funciona](#como-funciona)\r\n    - [Controller](#controller)\r\n    - [Service](#service)\r\n    - [DAO](#dao)\r\n- [Endpoints](#endpoints)\r\n    - [Usuários](#usuários)\r\n    - [Livros](#livros)\r\n\r\n\r\n## Sobre\r\nBiblioteca API é uma `REST API` desenvolvida para a conclusão do Santander Bootcamp 2023 - Backend Java.\r\n\r\nO objetivo foi simular operações de uma biblioteca, como registrar livros, usuários e emitir empréstimo de livros aos usuários registrados.\r\n\r\nA API foi desenvolvida na linguagem `Java` e utilizando `Spring Framework` e `PostgreSQL`.\r\n\r\nO projeto está disponível para acesso em [dio-lab-rest-api-production.up.railway.app](https://dio-lab-rest-api-production.up.railway.app/)\r\n\r\n## Como Funciona\r\n\r\nPor seguir a arquitetura `REST`, todas as operações são feitas utilizando `JSON`, tanto as respostas quanto as requisições. E as requisições, por sua vez, são feitas através de metódos HTTP.\r\n\r\nAs requisições que enviam um corpo, vão ter seu corpo validado na camada mais externa da aplicação. Como a aplicação segue uma arquitetura de 3 camadas, a mais externa seria a - `controller`.\r\n\r\nToda a regra de negócios da API está na camada de serviços - `service`, que por sua vez se comunica com a camada `DAO`. E é nessa última camada, `DAO`, onde é feita a modelagem dos dados e a execução de operações ao banco de dados.\r\n\r\n### Controller\r\nResponsável por receber requisições e comunicá-las a camada `service`, receber as respostas e devolvê-las ao cliente. É, também, responsável por validar o corpo das requisições utilizando `DTOs`.  \r\nAs exceções, quando jogadas pela aplicação, são tratadas nessa camada.\r\n\r\n#### WebResponse\r\nO controller faz o uso de uma classe customizada - WebResponse, para enviar as respostas ao cliente. Esse por sua vez utiliza o `ResponseEntity` para manipular as respostas HTTP a serem enviadas ao cliente.  \r\nEssa classe possui 4 propriedades:\r\n- `status`: mensagens customizadas de status da resposta.\r\n    - *sucesso*: requisição recebida, executada.\r\n        - HttpStatus: `200 - OK` / `201 - CREATED`\r\n    - *sucesso impedido*: requisição recebida porém a execução foi impedida.\r\n        - HttpStatus: `200 - OK`\r\n    - *erro cliente*\r\n        - HttpStatus: `400 - Bad Request`\r\n    - *erro server*\r\n        - HttpStatus: `500 - Server Internal Error`\r\n- `timestamp`: a data da resposta.\r\n- `message`: Um objeto que contém a resposta para a requisição do cliente.\r\n\r\n### Service\r\nPor conter a regra de negócio da aplicação, recebe o pedido do cliente e o responde através do `controller`. Possui, também, uma comunicação com a camada `DAO` o que permite acessar o banco de dados.\r\n\r\n### DAO\r\nUtilizando o `Spring Data JPA`, faz a modelagem e mapeamento dos dados, e com o `Repository` executa *queries* ao banco de dados.\r\n\r\n### Endpoints\r\nAqui estão todos os endpoints disponíveis na aplicação. Assim como, as respostas esperadas e, no caso dos métodos `POST` e `PUT`, o que se espera no corpo da requisição.\r\n\r\nA aplicação conta com o [OpenAPI/Swagger UI](https://dio-lab-rest-api-production.up.railway.app/swagger-ui/index.html) para executar operações nos *endpoints*.\r\n\r\n#### Usuários\r\nAs operações envolvendo os usuários são feitas no endpoint `/customers`  \r\nO usuário recebe o `registration` após fazer o registro na biblioteca.\r\n\r\n##### GET\r\n`/customers/{registration}`  \r\n- **Retorna** uma mensagem de sucesso contendo o usuário correspondente ao cpf indicado.\r\n\r\n##### POST\r\n`/customers`  \r\n- **Requer** um corpo contendo as nome e cpf(sem pontos e traços).\r\n- **Retorna** uma mensagem de sucesso com informações do usuário como `name`, `cpf`, `registration`.\r\n\r\n##### PUT\r\n`/customers/{id}`  \r\n- **Requer** um corpo contendo as atualizações a serem feitas.\r\n- **Retorna** uma mensagem de sucesso contendo as informações atualizadas.\r\n\r\n##### DELETE\r\n`/customers/{id}`  \r\n- **Retorna** um status code de 204, indicando sucesso na operação e corpo da mensagem vazio.\r\n\r\n#### Livros\r\nAs operações envolvendo os livro são feitas no endpoint `/books`\r\n\r\n##### GET\r\n`/books`  \r\n- **Retorna** uma mensagem de sucesso com uma lista contendo todos os livros registrados no banco de dados.\r\n\r\n`/books/{id}`  \r\n- **Retorna** uma mensagem de sucesso contendo o livro correspondente ao id indicado.\r\n\r\n##### POST\r\n`/books`  \r\n- **Requer** um corpo contendo título, autor e data da publicação.\r\n- **Retorna** uma mensagem de sucesso.\r\n\r\n`/books/{id}/loans`  \r\n- **Requer** um corpo contendo os dados do usuário a fazer um empréstimo.\r\n- **Retorna** uma mensagem de sucesso contendo detalhes do empréstimo.\r\n\r\n##### PUT\r\n`/books/{id}`  \r\n- **Requer** um corpo contendo as atualizações a serem feitas a um livro.\r\n- **Retorna** uma mensagem de sucesso contendo o livro atualizado.\r\n\r\n`/books/{id}/loans`  \r\n- **Requer** um corpo contendo os dados do usuário que realizou o empréstimo.\r\n- **Retorna** uma mensagem de sucesso contendo detalhes atualizados do empréstimo.\r\n\r\n##### DELETE\r\n`/books/{id}`  \r\n- **Retorna** um status code de 204, indicando sucesso na operação e corpo da mensagem vazio.\r\n\r\nExecute as operações acima com [OpenAPI/Swagger UI](https://dio-lab-rest-api-production.up.railway.app/swagger-ui/index.html).\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjvitoralb%2Fdio-lab-rest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjvitoralb%2Fdio-lab-rest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjvitoralb%2Fdio-lab-rest-api/lists"}