A challenge project to implement a cat pictures API
- Docker
- Docker Compose
- Copy env_example file to .env
IMPORTANT: Before running this project locally, you MUST have a .env file in the project root (see steps above!)
docker-compose up : Bring up the API and dependencies (building them if necessary)
docker-compose down : Bring down the API and dependencies
DEFAULT URI: http://localhost:8080
POSTMAN COLLECTION: https://www.getpostman.com/collections/fa46ec11f62bb24ad333
The above link will load all of the requests and macros for authentication into Postman for you.
Open endpoints require no Authentication.
- HealthCheck :
GET /check
- Login :
POST /login
- New User :
POST /user
- Get Picture by ID :
GET /picture/:picture_id
- Get All Pictures :
GET /pictures
- Get All Pictures for User :
GET /user/:user_id/pictures
Closed endpoints require a valid Token to be included in the header of the request. A Token can be acquired from the Login view above.
- Create Picture :
POST /auth/picture
- Update Picture :
PUT /auth/picture/:picture_id
- Delete Picture :
DELETE /auth/picture/:picture_id