xn-api 1.0.3.dev1

Simplest fastest minimal REST API CRUD generator for Tortoise ORM models

X-API

Simplest fastest minimal REST API CRUD generator for Tortoise ORM models.

Fully async Zero config One line ASGI app

Requirements

• Python >= 3.12

INSTALL

pip install tortoise-api

Run your app

• Describe your db models with Tortoise ORM in models.py module

from x_api import Model

class User(Model):
    id: int = fields.IntField(pk=True)
    name: str = fields.CharField(255, unique=True, null=False)
    posts: fields.ReverseRelation["Post"]

class Post(Model):
    id: int = fields.IntField(pk=True)
    text: str = fields.CharField(4095)
    user: User = fields.ForeignKeyField('models.User', related_name='posts')
    _name = 'text' # `_name` sets the attr for displaying related Post instace inside User (default='name')

• Write run script main.py: pass your models module in Api app:

from x_api import Api
import models

app = Api().start(models)

• Set DB_URL env variable in .env file
• Run it:

uvicorn main:app

Or you can just fork Completed minimal runnable example from sample apps.

And voila:

You have menu with all your models at root app route: http://127.0.0.1:8000

And JSON resources for each db Entity at /{modelName} routes:

And one separate Entity at /{modelName}/{entity_id} routes:

---

Made with ❤ on top of the FastAPI and TortoiseORM.