Skip to content

A challenge project to implement a cat pictures API

Notifications You must be signed in to change notification settings

gabbottron/catpix-api

Repository files navigation

catpix-api

A challenge project to implement a cat pictures API

Local dev setup

Dependencies

  1. Docker
  2. Docker Compose
  3. 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!)

Container Commands

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

Open endpoints require no Authentication.

Endpoints that require Authentication

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.

About

A challenge project to implement a cat pictures API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages