FastAPI Admin
Introduction
FastAPI-admin is a admin dashboard based on fastapi and tortoise-orm and rest-admin.
FastAPI-admin provide crud feature out-of-the-box with just a few config.
Screenshots
Quick Start
Backend
Only you should do is runing a fastapi app and mount admin app from fastapi-admin,then call init().
import uvicorn
from fastapi import FastAPI
from starlette.middleware.cors import CORSMiddleware
from tortoise.contrib.fastapi import register_tortoise
from fastapi_admin.factory import app as admin_app
from fastapi_admin.site import Site, Menu
TORTOISE_ORM = {
'connections': {
'default': 'mysql://root:123456@127.0.0.1:3306/test'
},
'apps': {
'models': {
'models': ['examples.models'],
'default_connection': 'default',
}
}
}
def create_app():
fast_app = FastAPI()
register_tortoise(fast_app, config=TORTOISE_ORM)
fast_app.mount('/admin', admin_app)
admin_app.init(
user_model='TestUser',
admin_secret='test',
models='examples.models',
site=Site(
name='FastAPI-Admin',
logo='https://github.com/long2ice/fastapi-admin/raw/master/front/static/img/logo.png',
locale='en-US',
locale_switcher=True,
menu=[
Menu(
name='Home',
url='/home',
icon='fa fa-home',
),
Menu(
name='Information',
title=True,
icon='fa fa-user',
),
Menu(
name='User',
url='/rest/TestUser', #important,TestUser is same of the Model class TestUser and must be /rest/<Model>.
icon='fa fa-user',
),
Menu(
name='Logout',
url='/logout',
icon='icon-lock',
)
]
)
)
fast_app.add_middleware(
CORSMiddleware,
allow_origins=['*'],
allow_credentials=True,
allow_methods=['*'],
allow_headers=['*'],
)
return fast_app
app = create_app()
if __name__ == '__main__':
uvicorn.run('main:app', port=8000, debug=True, reload=True)Front
cp .env.development.local.example .env and modify,then just run cd front && npm run serve,more reference in rest-admin.
Features
Enum Support
When you define a enum field of tortoise-orm,like IntEnumField,you can inherit fastapi_admin.enum.EnumMixin and impl choices() method,
FastAPI-admin will auto read and display and render a select widget in front.
class Status(EnumMixin, IntEnum):
on = 1
off = 2
@classmethod
def choices(cls):
return {
cls.on: 'ON',
cls.off: 'OFF'
}Admin User Model
Inherit fastapi_admin.models.User and add you own fields,then pass in init().
class AdminUser(User):
is_active = fields.BooleanField(default=False, description='Is Active')
status = fields.IntEnumField(Status, description='User Status')
created_at = fields.DatetimeField(auto_now_add=True)
updated_at = fields.DatetimeField(auto_now=True)Verbose Name
FastAPI-admin will auto read description defined in tortoise-orm model Field and display in front.
ForeignKeyField Support
If ForeignKeyField not passed in menu.raw_id_fields,FastAPI-admin will get all related objects and display select in front with Model.__str__.
JSONField Render
FastAPI-admin will render JSONField with jsoneditor as beauty interface.
Search Fields
Defined menu.search_fields in menu will render a search form by fields.
Deployment
- Deploy fastapi app by gunicorn+uvicorn or reference https://fastapi.tiangolo.com/deployment/.
- Run
npm run buildinfrontdir,then copy static files indiststo you server,deployment bynginx.
Note
Maybe you should config VUE_APP_API_URL, BASE_URL environment .etc in .env of front dir,just reference docs of rest-admin.
ThanksTo
- fastapi ,high performance async api framework.
- tortoise-orm ,familiar asyncio ORM for python.
- rest-admin,restful Admin Dashboard Based on Vue and Boostrap 4.
