Family Static API

The Jackson Family needs a static API! We need to build the data structures and create the API endpoints to interact with it using Hoppscotch (recommended) or Postman.

🌱 How to start this project

This project comes with the necessary files to start working immediately.

We recommend opening this very same repository using a provisioning tool like Codespaces (recommended) or Gitpod. Alternatively, you can clone it on your local computer using the git clone command.

This is the repository you need to open:

https://github.com/breatheco-de/exercise-family-static-api

👉 Please follow these steps on how to start a coding project.

💻 Installation

1. Install the project dependencies by running $ pipenv install

2. Get inside the virtual environment by running $ pipenv shell

3. Start the server by running $ pipenv run start

✅ Automatic grading

• Test your code by running $ pipenv run test

📝 Instructions

1. Create the code needed to implement the API endpoints described further below.

2. The only two files you have to edit are:

• src/datastructure.py: Contains the class with the rules on how to manage the family members.
• src/app.py: Contains the API, it uses the Family as data structure.

3. We have prepared a set of automated tests that will give you an idea if your code is correct. Run the tests by typing $ pipenv run test on the command line.

Data structures

Every member of the Jackson family must be a dictionary - the equivalent of Objects Literals in JS - and have these values:

+ id: Int
+ first_name: String
+ last_name: String (Always Jackson)
+ age: Int > 0
+ lucky_numbers: List of integers

The family data-structure will be a class with the following structure:

class FamilyStructure:
    def __init__(self, last_name):
        self.last_name = last_name
        self._next_id = 1
        self._members = []

    # This method generates a unique 'id' when adding members into the list (you shouldn't touch this function)
    def _generate_id(self):
        generated_id = self._next_id
        self._next_id += 1
        return generated_id

    def add_member(self, member):
        ## You have to implement this method
        ## Append the member to the list of _members
        pass

    def delete_member(self, id):
        ## You have to implement this method
        ## Loop the list and delete the member with the given id
        pass

    def get_member(self, id):
        ## You have to implement this method
        ## Loop all the members and return the one with the given id
        pass

    def get_all_members(self):
        return self._members

Note: don't forget to initialize the class: jackson_family = FamilyStructure('Jackson') before the routes.

These are the initial Family Members

John Jackson
33 Years old
Lucky Numbers: 7, 13, 22

Jane Jackson
35 Years old
Lucky Numbers: 10, 14, 3

Jimmy Jackson
5 Years old
Lucky Numbers: 1

Endpoints

This API must have 4 endpoints. They all return JSON:

1) Get all family members:

Which returns all members of the family.

GET /members

status_code: 200 if success. 400 if bad request (wrong info). 500 if the server encounters an error

RESPONSE BODY (content-type: application/json):

[]  <!--- List of members -->

2) Retrieve one member

Which returns the member of the family where id == member_id.

GET /member/<int:member_id>

RESPONSE (content_type: application/json):

status_code: 200 if success. 400 if bad request (wrong info). 500 if the server encounters an error


body:  <!--- The member's json object --> 
{
    "id": Int,
    "first_name": String,
    "age": Int,
    "lucky_numbers": List
}

3) Add (POST) new member

Which adds a new member to the family data structure.

POST /member

REQUEST BODY (content_type: application/json):
{
    id: Int,
    first_name: String,
    age: Int,
    lucky_numbers: []
}

RESPONSE (content_type: application/json):

status_code: 200 if success. 400 if a bad request (wrong info). 500 if the server encounters an error

4) DELETE one member

Which deletes a family member with id == member_id

DELETE /member/<int:member_id>

RESPONSE (content_type: application/json):

status_code: 200 if success. 400 if a bad request (wrong info). 500 if the server encounters an error

body: {
    done: True
}    

Requirements

• All requests and responses should be in content/type: application/json
• Response codes must be 200 for success, 400 for bad request, or 404 for not found.
• These exercises do not include a database, everything must be done in Runtime (RAM).

This and many other projects are built by students as part of the 4Geeks Academy Coding Bootcamp by Alejandro Sanchez and many other contributors. Find out more about our Full Stack Developer Course, and Data Science Bootcamp.