FasterAPI 0.0.31

No project description provided

FasterAPI

This is a simple start point for backend application based on FastAPI with JWT user authentication built for you. :)

How to use

First install it with pip. You do not need to install FastAPI seperately. All related libaray has been added as dependencies.

pip install FasterAPI

Then, you have to create a "auth-config.yaml" file, please make sure the file name is excat the same. This file should contains:

SQLALCHEMY_DATABASE_URL: "postgresql://postgres:postgres@127.0.0.1:5432/postgres" # url to your postgresql
SECRET_KEY: "8cfba7f89fca29a5f86cd8e02cb5381070690e378fc26cce4a311f84ce93672a" # create with openssl rand -hex 32
ALGORITHM: "HS256" # encryption algorithm
TOKEN_URL: "login" # url for login
TOKEN_EXPIRATION_TIME: 1 # token expiration time in minutes.
ALLOW_SELF_REGISTRATION: True # if true, anyone could register a user account. Otherwise, only superuser could.
ALLOW_MULTI_SESSIONS: False # if true, same user can login from different client. Otherwise, only one client is allowed.
# if any following configuration is missing, lowest security config will used for faster development!
# for non-website (include web app) you may want to use the default settings so your request won't be blocked.
ALLOW_CREDENTIALS: False # Here goes your choice for whether allow credential for CSRF protection
ALLOWED_ORIGINS: # Here goes your allowed origns for CSRF protection
  - "*"
ALLOWED_METHODS: # Here goes your allowed method for CSRF protection
  - "*"
ALLOWED_HEADERS: # Here goes your allowed headers for CSRF protection
  - "*"

Now, create a "main.py" file:

import uvicorn
from FasterAPI.utils import init_migration, create_superuser

if __name__ == "__main__":
    # create a superuser, optional
    create_superuser(
        username="admin",
        password="admin",
        first_name="admin",
        last_name="admin",
        email="[e-mail]"
    )
    # start the fastapi app
    uvicorn.run("FasterAPI:app", host="127.0.0.1", log_level="info", reload=True)

Finally, you could start the application by simply run the main.py.

Add additonal models and routes

If you need more models, you have to reference the base created inside FasterAPI:

from FasterAPI import Base

For your additional route, you have to reference the FasterAPI app instance like:

from FasterAPI.app import app

@app.get("/)
# your function goes here

Note that you will have to create a python module, place main.py and auth-config.yaml like following:

your_module:
  -- __init__.py
  -- models.py # your additional models
  -- schemas.py # your schemas
  -- routes.py # your addtional routes
main.py
auth_config.yaml

You can add meta data with "meta_config.yaml"

For example, the following "meta_config.yaml" will change the title and version, as well as enable the debug.

DEBUG: True
TITLE: "My API"
DESCRIPTION: "This is a description of my API"
VERSION: "0.0.2"
OPENAPI_URL: "/openapi.json"
DOCS_URL: "/docs"
REDOC_URL: "/redoc"
TERMS_OF_SERVICE: ""
CONTACT: ""
SUMMARY: "This is a summary of my API"

All the key words here is simply one to one mapping of FastAPI() constructor!

New! Now also built in with Opentelemetries for Tracing!, simple configure the following in meta_config.yaml

JAEGER_SVC_NAME: "my-api" # service name
JAEGER_TRACE: True # enable tracing
JAEGER_HOST: "localhost" # Jaeger host
JAEGER_PORT: "6831" # Jaeger host port