Skip to content

Spring Boot, H2, JPA, Hibernate Restful CRUD REST API for a Simple Notes application

Notifications You must be signed in to change notification settings

asopiah/Notes-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notes-API

This a simple Spring Boot, H2, JPA, Hibernate Restful CRUD REST API

Prerequisite/Requirements

  1. Java - 1.8.x

  2. Maven - 3.x.x

How to Setup the application /Installation

1. Clone the application

git clone https://github.com/asopiah/Notes-API.git

2. Build and run using maven

Just go to the root directory of the application and type the following command to run it.

mvn clean install

Then ..

mvn spring-boot:run

The app will start running at http://localhost:8080

Explore Rest APIs

The app defines following CRUD APIs.

GET /api/notes

POST /api/notes

GET /api/notes/{noteId}

PUT /api/notes/{noteId}

DELETE /api/notes/{noteId}

Testing the APIs

You can test them using postman or any other rest client

Me I am using RestLet Client chrome extension

alt text

I have deployed this rest API on Heroku

Use below endpoints to test CRUD operations live without running the application localy. You only require Postman or any other rest client.

GET https://sopia-notes-api.herokuapp.com/api/notes --Get all the notes

POST https://sopia-notes-api.herokuapp.com/api/notes -- Create a new note

GET https://sopia-notes-api.herokuapp.com/api/notes/{noteId} -- Get a specefic note

PUT https://sopia-notes-api.herokuapp.com/api/notes/{noteId} -- Update a given note

DELETE https://sopia-notes-api.herokuapp.com/api/notes/{noteId} -- Delete a given note

Issue

Please open an issue if you encounter an error while running or using this code

Please make sure to update tests as appropriate.

License

clone, use, modify and use as you may wish to

About

Spring Boot, H2, JPA, Hibernate Restful CRUD REST API for a Simple Notes application

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages