Latest Version: 0.7.4 (Patch Notes)

This repository contains back end code for a PostgreSQL database, made for educational purposes. At this time, it is not yet feature-complete, and while you are free to fork the codebase and use it for your own personal projects, do not expect support of any kind! You have been warned.

The current endpoints for this backend are described, below.

At the time of writing, the API is currently live on Heroku! Just append an endpoint of choice to the URL (for example, https://anywhere-fitness-bwft5.herokuapp.com/api/users if you want to get the list of all registered users).

Endpoints starting with /api/auth are related to the login/sign-up process.

Endpoint: [POST] /api/auth/register

Input: pass in an object containing the following registration information...

Output: on success, returns an object in the following format...

{
  "message": "New user registered, successfully!",
  "user": {
    "id": 4,
    "name": "Super Mario",
    "username": "supermario",
    "email": "[email protected]"
  }
}

Endpoint: [POST] /api/auth/login

Input: pass in an object containing the following login information

Output: on success, returns an object in the following format...

{
  "message": "Welcome, supermario!",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJqZWN0Ijo0LCJ1c2VyX2lkIjo0LCJ1c2VybmFtZSI6InN1cGVybWFyaW8iLCJlbWFpbCI6InN1cGVybWFyaW9AZ21haWw2NC5uZXQiLCJyb2xlX2lkIjoyLCJpYXQiOjE2MzcxMTc3NDIsImV4cCI6MTYzNzExODA0Mn0.cyytmVUTViGJ5cQhFozDlHIL-fuZ75ZBrijc-uu0RWI",
  "user": {
    "id": 4,
    "name": "Super Mario",
    "username": "supermario",
    "email": "[email protected]",
    "role_id": 2
  }
}

Endpoints starting with /api/classes are related to fitness class information.

Endpoint: [GET] /api/classes

Output: returns an array of fitness class objects

[
  {
    "attendees": 47,
    "id": 1,
    "duration": 120,
    "instructor": "John Snow",
    "intensity": "high",
    "location": "The Wall",
    "max_class_size": 64,
    "name": "Castle Black Combat",
    "start_time": "06:00:00",
    "type": "strength"
  },
  {
    "attendees": 16,
    "id": 2,
    "duration": 40,
    "instructor": "Wayward Pooch",
    "intensity": "medium",
    "location": "Koopa Troopa Beach",
    "max_class_size": 32,
    "name": "Pooch's Run",
    "start_time": "10:00:00",
    "type": "endurance"
  }
]

Endpoint: [GET] /api/classes/:id

Parameters: :id must be an integer representing the class ID

Output: returns an object containing information for a single fitness class

{
  "attendees": 47,
  "id": 1,
  "duration": 120,
  "instructor": "John Snow",
  "intensity": "high",
  "location": "The Wall",
  "max_class_size": 64,
  "name": "Castle Black Combat",
  "start_time": "06:00:00",
  "type": "strength"
}

This endpoint is protected; you must send your requests with a login token in the request header, and that token must be valid (not expired, correctly formatted) and for a user account registered as an instructor.

If you are not an instructor, you will receive an access denied message.

An instructor will be automatically added to the class's attendees list when successful.

Endpoint: [POST] /api/classes

Input: pass in an object with the following properties; optional arguments will be automatically filled in with the default values specified if left empty...

Notes: The fitness class categories/types are as follows...

Output: returns a success message and the newly created class

{
  "message": "Class created successfully!",
  "newClass": {
    "attendees": 1,
    "id": 3,
    "duration": 60,
    "instructor": "Super Mario",
    "intensity": "low",
    "location": "Your Happy Place",
    "max_class_size": 30,
    "name": "Best Class Ever",
    "start_time": "17:00:00",
    "type": "meditation"
  }
}

This endpoint requires a token in the header to know who's making the request. Can be either a client or instructor, but must be logged in. If a user is already a member of the class they are trying to join, the request will fail.

Endpoint: [GET] /api/classes/:id/join

Parameters: :id must be an integer, representing a fitness class's ID

Output: returns a success message

{
  "message": "Successfully joined class!"
}

This endpoint requires the person making the request to be the instructor who created the class; only instructors who actually made the class can delete it

Endpoint: [DELETE] /api/classes/:id

Parameters: :id must be an integer, representing a fitness class's ID

Output: returns a success message

{
  "message": "Successfully deleted class!"
}

Endpoints starting with /api/users are for fetching user information.

Endpoint: [GET] /api/users

Output: on success, returns an array of objects containing all the users in the database; this is for development purposes, and will likely go unused in the final release (the users depicted are not real -- they are listed for demonstrational purposes)

[
  ...
  {
    "email": "[email protected]",
    "id": 2,
    "name": "John Snow",
    "username": "johnsnow"
  },
  {
    "email": "[email protected]",
    "id": 3,
    "name": "Thorin Oakenshield",
    "username": "thorinoakenshield"
  },
  {
    "email": "[email protected]",
    "id": 4,
    "name": "Super Mario",
    "username": "supermario"
  },
  ...
]

Endpoint: [GET] /api/users/:id

Parameters: :id must be an integer

Output: if a user with the id provided in the URL parameter exists, their information will be outputted as an object in the following format...

{
  "email": "[email protected]",
  "id": 2,
  "name": "John Snow",
  "username": "johnsnow"
}

Endpoint: [GET] /api/users/:id/classes

Parameters: :id must be an integer representing user ID

Output: returns an array of classes a user is attending

[
  {
    "attendees": 47,
    "duration": 120,
    "id": 1,
    "instructor": "Wayward Pooch",
    "intensity": "high",
    "location": "The Wall",
    "max_class_size": 64,
    "name": "Castle Black Combat",
    "start_time": "06:00:00",
    "type": "strength"
  },
  {
    "attendees": 16,
    "duration": 40,
    "id": 2,
    "instructor": "Wayward Pooch",
    "intensity": "medium",
    "location": "Koopa Troopa Beach",
    "max_class_size": 32,
    "name": "Pooch's Run",
    "start_time": "10:00:00",
    "type": "endurance"
  }
]