SA Phase 4 Code Challenge : Pizza Restaurants [COMPULSORY]

• Due Jun 17 by 11:59pm
• Points 15
• Submitting a website url
• Available after Jun 12 at 12am

🍕 Pizza Restaurant API Challenge

Overview

Your task is to build a RESTful API for a Pizza Restaurant using Flask. You will implement models, validations, and routes from scratch — no frontend is required. You’ll test your API using Postman and provide clear documentation in a README.md.

🔃 GitHub Repository Setup Instructions

Before you start building, set up your GitHub repo to version and submit your work properly.

✅ Step 1: Create a new GitHub repository

1. Go to https://github.com Links to an external site.
2. Click New repository
3. Name your repo something like pizza-api-challenge
4. Keep it public (as advised)
5. Do not initialize with a README or.gitignore (you’ll do that locally)

🧱 Project Structure (MVC Preferred)

Follow the MVC (Model–View–Controller) pattern for structuring your application:
.
├── server/
│ ├── __init__.py
│ ├── app.py # App setup
│ ├── config.py # DB config, etc.
│ ├── models/ # 💾 Models (SQLAlchemy)
│ │ ├── __init__.py
│ │ └── restaurant.py
│ │ └── pizza.py
│ │ └── restaurant_pizza.py
│ ├── controllers/ # 🎯 Route handlers (Controllers)
│ │ ├── __init__.py
│ │ └── restaurant_controller.py
│ │ └── pizza_controller.py
│ │ └── restaurant_pizza_controller.py
│ ├── seed.py # Seed data
├── migrations/
├── challenge-1-pizzas.postman_collection.json
└── README.md

💡 If you're new to MVC, just think of:

• models/ = data layer
• controllers/ = route logic layer
• app.py = glue between the two

🧰 Setup Instructions

1. **Create a virtual environment and install packages

   pipenv install flask flask_sqlalchemy flask_migrate
   pipenv shell
   **

2. **Run DB setup commands

   export FLASK_APP=server/app.py
   flask db init
   flask db migrate -m "Initial migration"
   flask db upgrade

   **

3. **Seed the database

   Write data in server/seed.py and run:
   python server/seed.py

   **

🧩 Models

Implement these models inside the models/ folder.

Restaurant

• id: primary key
• name: string
• address: string

Relationships:

• has many RestaurantPizzas

Pizza

• id: primary key
• name: string
• ingredients: string

Relationships:

• has many RestaurantPizzas

RestaurantPizza (Join table)

• id: primary key
• price: integer (validation: must be between 1 and 30)
• restaurant_id: FK
• pizza_id: FK

Relationships:

• belongs to Restaurant and Pizza

✅ Ensure cascading deletes when a Restaurant is deleted.

🛠 Required Routes (Define in Controllers)

Each controller should handle one resource.

GET /restaurants

Returns a list of all restaurants.

GET /restaurants/int:id

Returns details of a single restaurant and its pizzas.

• If not found → { "error": "Restaurant not found" } with 404

DELETE /restaurants/int:id

Deletes a restaurant and all related RestaurantPizzas.

• If successful → 204 No Content
• If not found → { "error": "Restaurant not found" } with 404

GET /pizzas

Returns a list of pizzas.

POST /restaurant_pizzas

Creates a new RestaurantPizza.

Request:

Success response:

Error response:

With 400 Bad Request

🔎 Testing

✅ Using Postman

Import the Postman collection:

1. Open Postman
2. Click Import → Upload challenge-1-pizzas.postman_collection.json
3. Test each route

🧾 README.md Requirements

Your README.md should include:

• Setup steps (pipenv, Flask commands)
• DB migration & seeding instructions
• Route summary
• Example requests & responses for each route
• Validation rules
• Postman usage instructions

✅ Submission Checklist

• MVC folder structure
• Models with validations and relationships
• All routes implemented
• Postman tests passing
• Well-written README.md

Keep in mind that 101 students have already been assessed using this rubric. Changing it will affect their evaluations.

Phase 4 Flask CC Rubric