justinjmiller / XTRAC_One

Assignment One

Description

RESTFul API used to allow external developers to request an API key for an organiation's public API

Assumptions

Built with Spring Boot. Data is stored in a simple static map of users and their applications. Model validation done with Hibernate validator (JSR 303)

Building

Dependencies via Maven. a simple mvn package will build the jar, which can then be executed with java -jar

API Examples

Add a user

curl http://localhost:8080/api/users -X "POST" -H "Content-Type: application/json" -d "{\"firstName\":\"justin\",\"lastName\":\"miller\",\"email\":\"[e-mail]\",\"telephone\":\"8015551212\"}"

Get a user

curl http://localhost:8080/api/users/[e-mail]

Update a user

curl http://localhost:8080/api/users/[e-mail] -X "PUT" -H "Content-Type: application/json" -d "{\"firstName\":\"justin\",\"lastName\":\"miller\",\"email\":\"[e-mail]\",\"telephone\":\"8005551212\"}"

Delete a user

curl http://localhost:8080/api/users/[e-mail] -X "DELETE"

Add a user application

curl http://localhost:8080/api/users/[e-mail]/applications -X "POST" -H "Content-Type: application/json" -d "{\"name\":\"app name\",\"description\":\"some app description\"}"

Get a users applications

curl http://localhost:8080/api/users/[e-mail]/applications