Skip to content

AhdTech-Backend-Intern/spring-boot-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Spring_Boot_Starter_API

Java Spring Boot Maven

This project is a **Spring Boot Starter** template that provides a foundation for building APIs. The project demonstrates an example of a RESTful API for managing a `Person` entity. It includes features such as basic CRUD operations and serves as a starting point for more complex Spring Boot applications.

Table of Contents

Features

  • Create, Read, Update, and Delete (CRUD) operations for Person entities.
  • RESTful API following best practices.
  • Built with Spring Boot, making it scalable and easy to extend.
  • Simple structure for rapid development and deployment.

Technologies Used

  • Java 11: The programming language used for the project.
  • Spring Boot 2.7.0: Simplifies the creation of production-grade Spring applications.
  • Maven 3.8.5: Build and dependency management tool.
  • H2 Database (Optional): In-memory database for development and testing.

Getting Started

Prerequisites

  • Java 11 or higher.
  • Maven installed on your system.
  • (Optional) H2 database for in-memory testing.

Installation

  1. Clone the repository:
    git clone https://github.com/BaraSedih11/spring-boot-starter.git
    cd spring-boot-starter
  2. Install the dependencies:
mvn clean install

Running the Application

To run the Spring Boot application, use the following command:

mvn spring-boot:run
  • The application will start on http://localhost:8080. *

API Documentation

The API exposes the following endpoints for managing Person entities:

  • GET /api/v1/person: Retrieve all persons.
  • GET /api/v1/person/{id}: Retrieve a specific person by ID.
  • POST /api/v1/person: Create a new person.
  • PUT /api/v1/person: Update an existing person.
  • DELETE /api/v1/person/{id}: Delete a person by ID.

Example JSON Payload for Creating a Person

{
  "name": "Bara Al-Sedih"
}

About

My first spring boot application, implements simple CRUD operations example

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages