Backend
Introduction
This is our backend service for our inclass project UniFree for CSC59939, instructed by Nikolai Avteniev
Overview
Server Side Database CRUD Microservice
Authentication
Must sign in to get JWT from POST User Sign In API
Error Codes
- 200 - Success
- 400 - Validation Error, please check your queries/body
- 401 - Autentication Error, must sign in before running any APIs
- 500 - Internal Server Error, please slack the channel for help
GETHealth Check (Live)
http://localhost:8081/healthcheck
Should return service information
- 200 - Service is live
- 500 - Service is not live
HEADERS
Content-Type
Example Request
Health Check (Live)
200 OK
Example Response
Server
Connection
X-Powered-By
Access-Control-Allow-Origin
Content-Type
Content-Length
Etag
Vary
Date
Via
POSTUser sign in (Live)
http://localhost:8081/api/v1/signin
Should Sign in with corresponded body, when it's signed in successfully. It should output the username and JWT
- 200 - Success
- 400 - Validation Errors
- 500 - Internal Server Error
HEADERS
Content-Type
Bodyraw
Example Request
User sign in
200 OK
Example Response
Server
Date
Content-Type
Transfer-Encoding
Connection
X-Powered-By
Access-Control-Allow-Origin
Vary
ETag
Content-Encoding
POSTSign Up User Account (Live)
http://localhost:8081/api/v1/signup
Should Sign up with corresponded body
- 200 - Success
- 400 - Validation Errors
- 500 - Internal Server Error
HEADERS
Content-Type
Bodyraw
Example Request
Sign Up User Account
200 OK
Example Response
Server
Date
Content-Type
Transfer-Encoding
Connection
X-Powered-By
Vary
ETag
Content-Encoding