Develop a Basic Inventory API with FastAPI

https://github.com/4GeeksAcademy/python-hello

📝 Instructions

Step 1: Set Up Your Environment

• Clone the base repository and follow the instructions in the README to install dependencies.
• Make sure to install the required libraries, such as FastAPI and Uvicorn, using this command:

1pip install fastapi uvicorn

Step 2: Define the Inventory Model

• Create a models.py file and define a model for the inventory items. Each item should include:

Example:

1from pydantic import BaseModel
2
3class Item(BaseModel):
4    id: int
5    name: str
6    quantity: int
7    price: float

Step 3: Create the API Routes

• In the main file of your application (e.g., main.py), set up the following routes:

Basic example:

1from fastapi import FastAPI
2
3app = FastAPI()
4
5inventory = []
6
7@app.get("/items")
8def get_items():
9    return inventory
10
11@app.post("/items")
12def add_item(item: Item):
13    inventory.append(item)
14    return item

Step 4: Test Your API

• Use tools like Postman or Thunder Client to test your API routes.
• You can also test your API using the interactive interface provided by FastAPI: open http://127.0.0.1:8000/docs in your browser.

Step 5: Add Optional Features

• Filter by Price Range: Enable filtering items by a specific price range.
• Search by Name: Implement a route to search for items by their name.
• Data Persistence: Connect your application to a database like SQLite using SQLAlchemy.
• Pagination: Implement pagination to display large amounts of data more efficiently.

Bonus Section

Additional Features to Practice

1. Authentication: Implement a basic authentication system to access the API.
2. Export Data: Add the option to export inventory data to a CSV or JSON file.
3. Deploy: Publish your API to a service like Heroku, Render, or Deta.
4. Advanced Validation: Use Pydantic to add extra validations to your models.

Explore different enhancements to make your API more functional and useful!