{"id":21357568,"url":"https://github.com/bedirhanssaglam/user-api","last_synced_at":"2026-02-10T10:39:04.225Z","repository":{"id":262889355,"uuid":"888679131","full_name":"bedirhanssaglam/user-api","owner":"bedirhanssaglam","description":"Simple Java Spring Boot application designed to manage user data with operations such as creating, updating, and deleting user information.","archived":false,"fork":false,"pushed_at":"2024-11-15T17:04:33.000Z","size":32,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-22T05:07:45.508Z","etag":null,"topics":["java","maven","spring","spring-boot"],"latest_commit_sha":null,"homepage":"","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/bedirhanssaglam.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":"2024-11-14T20:17:32.000Z","updated_at":"2024-11-15T18:51:10.000Z","dependencies_parsed_at":"2024-11-14T21:36:49.108Z","dependency_job_id":null,"html_url":"https://github.com/bedirhanssaglam/user-api","commit_stats":null,"previous_names":["bedirhanssaglam/user-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bedirhanssaglam%2Fuser-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bedirhanssaglam%2Fuser-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bedirhanssaglam%2Fuser-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bedirhanssaglam%2Fuser-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bedirhanssaglam","download_url":"https://codeload.github.com/bedirhanssaglam/user-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235163258,"owners_count":18945805,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","maven","spring","spring-boot"],"created_at":"2024-11-22T05:08:05.151Z","updated_at":"2026-02-10T10:39:04.138Z","avatar_url":"https://github.com/bedirhanssaglam.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# User API\n\nThis is a simple Java Spring Boot application designed to manage user data with operations such as creating, updating, and deleting user information. The application uses `ResponseWrapper` to standardize API responses.\n\n## Table of Contents\n1. [Features](#features)\n2. [Technologies Used](#technologies-used)\n3. [Setup and Installation](#setup-and-installation)\n4. [Endpoints](#endpoints)\n5. [Error Handling](#error-handling)\n6. [Postman Collection](#postman-collection)\n\n---\n\n### Features\n\n- CRUD operations for User entities:\n    - **Create a user**\n    - **Retrieve user(s)** by ID, email, or name\n    - **Update user information**\n    - **Delete a user**\n- Input validation (e.g., email format validation)\n- Standardized responses with `ResponseWrapper`\n\n### Technologies Used\n\n- Java 17+: Supports modern Java versions.\n- Spring Boot: Core framework for building web applications and services.\n- Spring Data MongoDB: Simplifies data management with MongoDB.\n- Velocity: Template engine for generating dynamic content.\n- Maven: Dependency management and build automation tool.\n\n---\n\n### Setup and Installation\n\n#### Prerequisites\n\n- Java 17 or higher\n- Maven\n- Git\n\n### Endpoints\n\n| HTTP Method | Endpoint            | Description                 |\n|-------------|----------------------|-----------------------------|\n| GET         | `/users`             | Retrieve all users          |\n| GET         | `/users/{id}`        | Retrieve a user by ID       |\n| GET         | `/users/email/{email}` | Retrieve a user by email    |\n| GET         | `/users/name/{name}` | Retrieve users by name      |\n| POST        | `/users`             | Create a new user           |\n| PUT         | `/users/{id}`        | Update a user by ID         |\n| DELETE      | `/users/{id}`        | Delete a user by ID         |\n\n#### Sample API Requests\n\n1. **Retrieve a user by email:**\n\n```http\nGET /users/email/{email}\n```\n\nExample Response:\n\n```json\n{\n   \"code\": 200,\n   \"data\": {\n      \"id\": \"673600a3deaeb9142bc0ed94\",\n      \"name\": \"Bedirhan Saglam\",\n      \"email\": \"bedirhansaglam270@gmail.com\"\n   },\n   \"message\": null\n}\n```\n\n2. **Create a new user:**\n\n```http\nPOST /users\n```\n\nExample Request Body:\n\n```json\n{\n  \"name\": \"Bedirhan Saglam\",\n  \"email\": \"bedirhansaglam270@gmail.com\"\n}\n```\n\nExample Response:\n\n```json\n{\n  \"code\": 201,\n  \"data\": {\n    \"id\": \"1\",\n    \"name\": \"Bedirhan Saglam\",\n    \"email\": \"bedirhansaglam270@gmail.com\"\n  },\n  \"message\": \"User created successfully.\"\n}\n```\n\n### Error Handling\nThis application uses a custom `ResponseWrapper` class to standardize API responses and error messages.\n\n#### Common Error Messages\n- Invalid Email Format: Returned when the provided email is invalid.\n- User Not Found: Returned when no user is found for the specified criteria.\n- Email Already Used: Returned when attempting to create or update a user with an email that already exists.\n\n### Postman Collection\nYou can download Postman collection from `postman` folder. Its appearance is as follows:\n\n\u003cimg width=\"276\" alt=\"postman_collection\" src=\"https://github.com/user-attachments/assets/3131b107-311a-4636-9d0f-6c1374f55228\"\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbedirhanssaglam%2Fuser-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbedirhanssaglam%2Fuser-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbedirhanssaglam%2Fuser-api/lists"}