mungasoftwiz/airbnb_clone_v3

Extension of the project to include API routes using python-flask.

Hello there👋, I'm Munga

AI Software Engineer

• 🔭 I’m currently working on AI projects at Headstarter AI

• 🌱 I’m currently learning about LLMs, RAG, Generative AI

• 💬 Ask me about Backend Engineering and System Design

• ⚡ Fun fact: I once created an 'Oops' loop so infinite it took 3 cups of coffee to break free!.

Connect and reach me 🤝📫:

Munga's Tech Toolbox 🧰:

airbnb_clone_v3's Issues

feat: improve storage

Update DBStorage and FileStorage, adding two new methods. All changes should be done in the branch storage_get_count:

1. A method to retrieve one object:

• Prototype: def get(self, cls, id):
• Returns the object based on the class and its ID, or None if not found.

2. A method to count the number of objects in storage:

• Prototype: def count(self, cls=None):
• Returns the number of objects in storage matching the given class. If no class is passed, returns the count of all objects in storage.

test: add new tests as much as you can

Since the beginning we’ve been using the unittest module, but do you know why unittests are so important?

Because when you add a new feature, you refactor a piece of code, etc… you want to be sure you didn’t break anything.

The following requirements must be met for your project:

1. All current tests must pass (don’t delete them…)
2. Add new tests as much as you can (tests are mandatory for some tasks)

feat: create State RESTful API

• Create a new view for State objects that handles all default RESTFul API actions

feat: add page not found

Designers are really creative when they have to design a “404 page”, a “Not found”

Today it’s different, because you won’t use HTML and CSS, but JSON!

In api/v1/app.py, create a handler for 404 errors that returns a JSON-formatted 404 status code response. The content should be: "error": "Not found"

feat: create Amenity RESTful API

• Create a new view for Amenity objects that handles all default RESTFul API actions

feat: create User RESTful API

• Create a new view for User object that handles all default RESTFul API actions

feat: start API development(status of your API)

Your first endpoint (route) will be to return the status of your API:

• Create a folder api at the root of the project with an empty file __init__.py
• Create a folder v1 inside api: this is where you will create the application file, methods, host and port parameters.
• Create a folder views inside v1: this is where you will create the blueprint and views.

feat: create Reviews RESTful API

• Create a new view for Review object that handles all default RESTFul API actions.

feat: HTTP access control (CORS)

CORS
A resource makes a cross-origin HTTP request when it requests a resource from a different domain, or port, than the one the first resource itself serves.

Why do we need this?
Because you will soon start allowing a web client to make requests your API. If your API doesn’t have a correct CORS setup, your web client won’t be able to access your data.

With Flask, it’s really easy, you will use the class CORS of the module flask_cors.

How to install it: $ pip3 install flask_cors
Update api/v1/app.py to create a CORS instance allowing: /* for 0.0.0.0

feat: create City RESTful API

• Same as State, create a new view for City objects that handles all default RESTFul API actions

feat: create Place RESTful API

• Create a new view for Place objects that handles all default RESTFul API actions.

feat: some stats?

Create an endpoint that retrieves the number of each objects by type:

• In api/v1/views/index.py
• Route: /api/v1/stats
• You must use the newly added count() method from storage

NB: No need to have a pretty rendered output, it’s a JSON, only the structure is important