mrrutledge / springapp

API to encourage potential voters to register and pledge to vote. The API is built using Spring boot framework and gradle.

SpringApp API

API to encourage potential voters to register and pledge to vote. The API is built using Spring boot framework and gradle. Clone the repo and play with it to see how it works, run it in your favorite IDE, test it with the requests below.

Tools

SpringBoot: 1.5.10.
Gradle: 5.0
Java: 8

Get and Post requests to try out in your bash terminal

Read Hello

curl -i -H "Content-Type: application/json" -X GET localhost:8080/hello

Add new pledge

curl -i -H "Content-Type: application/json" -X POST -d '{
    "name": "Random Guy",
     "statement": "I vote to change the world!"
     }' localhost:8080/pledges

Add new pledge

 curl -i -H "Content-Type: application/json" -X POST -d '{
     "name": "Honest Hill",
      "statement": "I vote to the system !"
      }' localhost:8080/pledges

List all pledges

curl -i -H "Content-Type: application/json" \
    -X GET localhost:8080/pledges

Get one Pledge

curl -i -H "Content-Type: application/json" \
    -X GET localhost:8080/pledges/2

Change one pledge

curl -i -H "Content-Type: application/json" -X POST -d '{
        "name": "Little Pray",
        "statement": "I vote for the future!"
    }' localhost:8080/pledges/2

Possible usage

We can build a web app with similar functionality, just add a UI with a bit more functions and we get ourselves an app.

Reference: Dr. B Fraser, Spring with Intellij.

springapp's Issues

Code cleanup

Hi there!

It is my intention to start contributing on some open source projects, but since I've not done this before and stumbled upon yours I hoped I could help you a bit 😄.

I would like to do some code cleanup and add some unit tests for your controller. I first want to do the cleanup and create a PR for that.

The cleanup is mainly about moving the MakeSpringPrettyPrintJSON to a different package, since it's no controller. I'd also like to create a separate controller for the /hello call which would mean that we can use a @RequestMapping("pledges") to clean that part a bit up as well.

Let me know!