Python FastAPI Starter API

Tech Stack

This starter template provides a robust backend setup using the following technology stack:

Logic: Python

• Python: A versatile, high-level programming language that's widely used for various applications, from web development to data analysis. Python is known for its simplicity and readability, which makes it an excellent choice for quick development cycles and collaborative environments.

API Framework: FastAPI

• FastAPI: A modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints. Some advantages of FastAPI include:
  • Performance: Ranks among the fastest web frameworks available, on par with NodeJS or Go.
  • Automatic Interactive Docs: With FastAPI, you automatically get interactive API documentation (using Swagger UI and ReDoc) that lets you call and test your API directly from the browser.
  • Easy to Use: Designed to be easy to use, while also enabling new, high-level features not available before.

Validation: Pydantic

• Pydantic: A data validation and settings management tool using Python type annotations. Pydantic's main features include:
  • Validation: Provides an easy way to validate data to ensure it meets specific constraints and formats.
  • Serialization: Converts complex types, such as ORM objects, into JSON-serializable formats.
  • Type Safety: Ensures data consistency and reduces runtime errors by using Python type hints.

Database: MongoDB

• MongoDB: A popular, NoSQL database known for its scalability and flexibility. With MongoDB, you can:
  • Flexibly Structure Data: Unlike relational databases, MongoDB allows for a more flexible data model, which can adapt over time.
  • Scale Out: Distribute data across many servers easily, with automatic load balancing.
  • Store Large Volumes: Handle massive volumes of data without compromising on speed and efficiency.

Getting Started

Follow the steps below to set up the project on your local machine:

1. Set Up Virtual Environment (venv)

Before you begin, ensure you have Python installed on your machine. Then, create a virtual environment:

python3 -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

2. Give Permission to Install Script

Make the install.sh script executable:

chmod +x install.sh

3. Install Dependencies

Run the install.sh script to install necessary dependencies:

./install.sh

4. Create .env File

In the root directory of the project, create a new .env file and add your MongoDB connection URL:

echo "MONGO_URL=your_mongo_connection_url" > .env

Replace your_mongo_connection_url with your actual MongoDB connection URL.

5. Update Collection Name

Open the file app/database.py and update the collection_name on line 77 to match the specific collection you intend to use.

6. Give Permission to Run Script

Make the run.sh script executable:

chmod +x run.sh

7. Run the Application

Execute the run.sh script to start the application:

./run.sh

Your application should now be up and running!

Sample Endpoints

All provided endpoints return JSON-compatible data.

API Root / Swagger Docs

Access the interactive documentation for all endpoints.

Endpoint: / HTTP Method: GET

API Version

Fetch the current version of the API.

Endpoint: /version HTTP Method: GET Response: String

Create User

Add a new user to the database.

Endpoint: /create-user HTTP Method: POST Input: User Response: Bool

Read Users

Retrieve a list of users based on provided query parameters.

Endpoint: /read-users HTTP Method: PUT Input: Query Response: Array[User]

Update Users

Update existing user data based on the provided query and update parameters.

Endpoint: /update-users HTTP Method: PATCH Input: Query, Update Response: Bool

Delete Users

Remove users from the database based on the provided query.

Endpoint: /delete-users HTTP Method: DELETE Input: Query Response: Bool

Sample Data Schemas

The following classes are used to validate incoming data to the API:

User

• name
  Required String
  Constraints: maxLength: 128, minLength: 3

• age
  Required Integer
  Constraints: maximum: 120, minimum: 1

• email
  Required String (EmailStr)

• active
  Optional Boolean

• score
  Required Float
  Constraints: maximum: 1, minimum: 0

UserQuery

• name
  Optional String
  Constraints: maxLength: 128, minLength: 3

• age
  Optional Integer
  Constraints: maximum: 120, minimum: 1

• email
  Optional String (EmailStr)

• active
  Optional Boolean

• score
  Optional Float
  Constraints: maximum: 1, minimum: 0

UserUpdate

• name
  Optional String
  Constraints: maxLength: 128, minLength: 3

• age
  Optional Integer
  Constraints: maximum: 120, minimum: 1

• email
  Optional String (EmailStr)

• active
  Optional Boolean

• score
  Optional Float
  Constraints: maximum: 1, minimum: 0

---

Thank you for choosing this starter template for your API projects. Should you have any feedback or questions, feel free to contribute or reach out!