README.md

FastAPI (API) Server

Simple FastAPI Boilerplate enhanced with JWT authentication, OAuth via GitHub, SqlAlchemy, SQLite persistence and deployment scripts via Docker - Provided by AppSeed. It has all the ready-to-use bare minimum essentials and active versioning and support.

Product Roadmap & Features:

Status	Item	info
✅	Up-to-date Dependencies	-
✅	API Definition	the unified API structure implemented by this server
✅	JWT Authentication	(login, logout, register) via oauth2
✅	OAuth	via GitHub`
✅	Persistence	SQLite, MySql
✅	Docker	-
✅	Unitary tests	minimal suite

✨ Quick Start in Docker

Get the code

$ git clone https://github.com/app-generator/api-server-fastapi.git
$ cd api-server-fastapi

Start the app in Docker

$ docker-compose up --build  

Note: The env.sample file will be used to set the environment variables for the docker container. Make sure to set them as needed. The API server will start using the PORT 5000.

✨ Table of Contents

1. Getting Started
2. Project Structure
3. Modules
4. Testing

✨ How to use the code

Step #1 - Clone the project

$ git clone https://github.com/app-generator/api-server-flask.git
$ cd api-server-flask

Step #2 - create virtual environment using python3 and activate it (keep it outside our project directory)

$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv env
$ # .\env\Scripts\activate

Step #3 - Install dependencies in virtualenv

$ pip install -r requirements.txt

Step #5 - Create a new .env file using sample env.sample

The meaning of each variable can be found below:

• DEBUG: if True the app runs in develoment mode
  • For production value False should be used
• SECRET_KEY: used in assets management
• GITHUB_CLIENT_ID: For GitHub social login
• GITHUB_SECRET_KEY: For GitHub social login
• DATABASE_HOSTNAME: For Mysql databse
• DATABASE_PORT: For Mysql databse
• DATABASE_PASSWORD: For Mysql databse
• DATABASE_NAME: For Mysql databse
• DATABASE_USERNAME: For Mysql databse
• ALGORITHM: For JWT Tokens
• ACCESS_TOKEN_EXPIRE_MINUTES: For JWT Tokens

Step #6 - start test APIs server at localhost:5000

$ uvicorn src.app:app

Use the API via POSTMAN or Swagger Dashboard.

✨ Project Structure

api-server-flask/
├── src
    ├── helpers
        ├── database.py
        └── utils.py
    ├── routers
        ├── users.py
│   ├── __init__.py
│   ├── app.py
│   ├── config.py
│   ├── models.py
│   ├── oatuh2.py
│   └── schemas.py
├── tests
    ├── __init__.py
    ├── conftest.py
    ├── database.py
    └── test_users.py
├── Dockerfile
├── docker-compose.yaml
├── README.md
├── requirements.txt
├── run.py

✨ API

For a fast set up, use this POSTMAN file: api_sample

Register - api/users/register (POST request)

POST api/users/register
Content-Type: application/json

{
    "username":"test",
    "password":"pass", 
    "email":"[email protected]"
}

Login - api/users/login (POST request)

POST /api/users/login
Content-Type: application/json

{
    "password":"pass", 
    "email":"[email protected]"
}

Logout - api/users/logout (POST request)

POST api/users/logout
Content-Type: application/json
authorization: JWT_TOKEN (returned by Login request)

{
    "token":"JWT_TOKEN"
}

✨ Testing

Run tests using pytest tests.py

---

FastAPI (API) Server - provided by AppSeed