Skip to content

propalparolnapervom/saas-template

 
 

Repository files navigation

Software Engineering Course project template

Setup dev environment

  • Grab Ubuntu 16.04 based VM
  • Clone projects
  > cd ~
  > mkdir projects
  > cd projects
  > git clone https://github.com/swe-course/saas-template.git
  • Install prerequisites, Prepare local env configuration files
  > cd saas-template
  > sudo ./prereq.sh
  > cp .env.template .env
  > cp settings.xml.template settings.xml
  • build & run
  > ./build.sh
  > sudo ./up.sh -d

API endpoints

Endpoint Details
/application.wadl Get XML based API description [GET]:
curl http://<host>:<port>/application.wadl

Not Allowed - OPTIONS, HEAD, POST, PUT, PATCH, DELETE, TRACE
/healthcheck Health check [GET]:
curl http://<host>:<port>/healthcheck

Not Allowed - OPTIONS, HEAD, POST, PUT, PATCH, DELETE, TRACE
/contacts Get/Find contacts [GET]:
curl http://<host>:<port>/api/v1/contacts
curl http://<host>:<port>/api/v1/contacts?firstName=John&email=.*unknown.com

Not Allowed - OPTIONS, HEAD, POST, PUT, PATCH, DELETE, TRACE
/contacts/{uuid} Get contact by Id [GET]:
curl http://<host>:<port>/api/v1/contacts/1

Create contact [POST]:
curl -H "Content-Type: application/json" -d '{"email":"first_name.last_name@gmail.com","firstName":"first_name","lastName":"last_name"}' http://<host>:<port>/api/v1/contacts

Update contact [PUT]:
curl --request PUT -H "Content-Type: application/json" -d '{"email":"elom_musk@gmail.com","firstName":"Elon","lastName":"Musk"}' http://<host>:<port>/api/v1/contacts/2

Patch contact [PATCH]:
curl --request PATCH -H "Content-Type: application/json" -d '{"email":"elom.musk@gmail.com"}' http://<host>:<port>/api/v1/contacts/2

Delete contact:
curl --request DELETE http://<host>:<port>/api/v1/contacts/2

Not Allowed - OPTIONS, HEAD, TRACE

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 60.6%
  • JavaScript 18.3%
  • TypeScript 8.2%
  • Shell 7.2%
  • CSS 4.3%
  • HTML 1.4%