https://github.com/vishvasg14/basicrestapp
REST application developed in spring boot v3, demonstrates api creation and and response handling
https://github.com/vishvasg14/basicrestapp
rest-api spring-boot
Last synced: 3 months ago
JSON representation
REST application developed in spring boot v3, demonstrates api creation and and response handling
- Host: GitHub
- URL: https://github.com/vishvasg14/basicrestapp
- Owner: vishvasg14
- Created: 2024-06-05T11:57:51.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-07T10:39:11.000Z (about 2 years ago)
- Last Synced: 2025-02-25T15:28:53.924Z (over 1 year ago)
- Topics: rest-api, spring-boot
- Language: Java
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Java REST Application using Spring Tool Suite (STS)
**Welcome to the Java REST Application repository created using Spring Tool Suite (STS)!**
This project serves as a template for building **RESTful APIs** using Java and **Spring Boot** framework.
## Features
- **RESTful Endpoints**: Implements RESTful endpoints to perform CRUD operations.
- **Spring Boot**: Utilizes Spring Boot framework for easy application setup and development.
- **Database Integration**: Demonstrates database integration for data storage using Spring Data JPA.
- **Swagger Documentation**: Integrates Swagger for API documentation and exploration.
## Getting Started
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
- **Java Development Kit (JDK)** - Java 11 or later.
- **Spring Tool Suite (STS)** - Integrated Development Environment (IDE) for building Spring-based applications.
- **Git** - Version control system for managing project files.
### Installation
1. Clone the repository to your local machine:
```bash
git clone https://github.com/your-username/java-rest-application.git
```
2. Import the project into Spring Tool Suite:
- Launch Spring Tool Suite.
- Select `File` > `Import`.
- Choose `Existing Maven Projects` and click `Next`.
- Browse to the directory where you cloned the repository and select the project.
- Click `Finish` to import the project into STS.
3. Run the application:
- Right-click on the project in the Project Explorer.
- Go to `Run As` > `Spring Boot App`.
- Alternatively, you can run the application using Maven: `mvn spring-boot:run`.
4. Access the application:
- Once the application is running, you can access it at [http://localhost:8080](http://localhost:8080).
- Explore the API documentation using Swagger UI at [http://localhost:8080/swagger-ui/index.html](http://localhost:8080/swagger-ui/index.html).
## Contributing
Contributions are welcome! Please read the **CONTRIBUTING.md** file for details on how to contribute to this project.
## License
This project is licensed under the **MIT License** - see the **LICENSE.md** file for details.
## Acknowledgments
- Hat tip to anyone whose code was used.
- Inspiration.
- etc.