blackadi / RESTful-API-SpringBoot

RESTful API design to explain how HTTP method(GET/POST/PUT/DELETE) can be implemented via Spring Framework.

Startup Guide - RESTful API using Java spring ♨️

This is a simple project for utilizing RESTful web service with spring framework.

What you need to get started:

1. Postman, for creating HTTP request and inspecting HTTP response.
2. Spring Tool Suite.
3. JDK.
4. Apache Maven, can be used to build and run the app from command line tool.

Getting Started

Build and run this application using command line tools

1. At the root level of this repository, run

   $ mvn install
   

2. Navigate to the target directory, and execute the .jar file inside.

3. Finally, execute by running

   $ java -jar <JAR_FILE_NAME>.jar
   

4. Open a web browser and nagivate to this URL http://localhost:8080/users

5. Now you can test any of the CRUD operation for http methods.

Reference Documentation

For further reference, please consider the following sections:

• Official Apache Maven documentation
• Spring Boot Maven Plugin Reference Guide
• Create an OCI image
• Spring Web
• Spring Boot DevTools
• Spring Boot Actuator

Guides

The following guides illustrate how to use some features concretely:

• Building a RESTful Web Service
• Serving Web Content with Spring MVC
• Building REST services with Spring
• Building a RESTful Web Service with Spring Boot Actuator