FastAPI Backend

Summary

This is a base FastAPI application providing a foundation for building robust and scalable backend services. It includes features such as user authentication, role-based access control, and database integration using SQLAlchemy. This application can be used as a starting point for developing various types of backend systems, including REST APIs and microservices.

Key features:

• User authentication and authorization
• Role-based access control
• Database integration with SQLAlchemy
• Database migrations with Alembic
• Command-line interface for managing the application
• Proper logging and error handling
• API endpoint documentation with Swagger UI
• Docker support for easy deployment

Technologies used:

• FastAPI
• SQLAlchemy
• Alembic
• Docker

Project Setup:

• Create python virtual environment & activate it.
• Install the requirements from requirements.txt by running pip install -r requirements.txt.
• Create a .env file from example.env and fill up the variables.
• You can select the database of your choice. By default, the application is configured to use SQLite. If you want to use MysQL set DB_TYPE to mysql and fill up the MYSQL variables.
• Run the application by running uvicorn app:app --host 0.0.0.0 --port 8001 --reload. The application server will be running on port 8001 & watch for any changes. Change to your desired port if needed.
• Visit http://localhost:8001 to verify if the application server has started successfully.

API Endpoints

The following API endpoints are available:

• /auth/login (POST): Authenticates a user and returns an access token and refresh token.
• /auth/refresh-token (POST): Refreshes an access token using a refresh token.
• /auth/logout (POST): Blacklists a refresh token to log out a user.
• /auth/password-reset (POST): Resets a user's password.
• /departments (GET): Retrieves a list of departments.
• /departments/{department_id} (GET): Retrieves a specific department by ID.
• /departments (POST): Creates a new department.
• /departments/{department_id} (PUT): Updates an existing department.
• /departments/{department_id} (DELETE): Deletes a department.
• /permissions (GET): Retrieves a list of permissions.
• /permissions/{permission_id} (GET): Retrieves a specific permission by ID.
• /permissions (POST): Creates a new permission.
• /permissions/{permission_id} (PUT): Updates an existing permission.
• /permissions/{permission_id} (DELETE): Deletes a permission.
• /roles (GET): Retrieves a list of roles.
• /roles/{role_id} (GET): Retrieves a specific role by ID.
• /roles (POST): Creates a new role.
• /roles/{role_id} (PUT): Updates an existing role.
• /roles/{role_id} (DELETE): Deletes a role.
• /users (GET): Retrieves a list of users.
• /users/{user_id} (GET): Retrieves a specific user by ID.
• /users (POST): Creates a new user.
• /users/{user_id} (PUT): Updates an existing user.
• /users/{user_id} (DELETE): Deletes a user.

API Documentation Endpoints(Avaliable only in debug mode):

• /docs: Swagger UI documentation for the API endpoints.
• /redoc: ReDoc documentation for the API endpoints.

Database Setup

The application is configured to use SQLite by default. To use a different database, such as MySQL, you will need to update the following environment variables in the .env file:

• DB_TYPE: Set to mysql.
• DB_HOST: The hostname or IP address of the database server.
• DB_PORT: The port number of the database server.
• DB_NAME: The name of the database.
• DB_USER: The username for connecting to the database.
• DB_PASS: The password for connecting to the database.

After configuring the database connection, you will need to run the database migrations to create the necessary tables. You can do this by running the following command:

alembic upgrade head

CLI Commands

The following cli commands are available:

• python cli.py:
  • generate_key: Generates a new secret key.
  • create_department: Creates a new department.
  • create_superuser: Creates a new superuser.
  • create_module: Creates a new module.
  • create_permission: Creates a new permission.

Deployment

The application can be deployed using Docker. To build the Docker image, run the following command:

docker build -t fast-api-base .

To run the Docker container, run the following command:

docker-compose up -d

Or you can build and run the Docker container in a single command:

docker-compose up -d --build

This will start the application in a detached mode. You can then access the application at http://localhost:8001.