Skip to main content

Craft your API the easy way — Production-ready REST API framework built on FastAPI + MongoDB

Project description

Craft Easy API

Craft your API the easy way.

A production-ready base system for REST APIs built on FastAPI + MongoDB. Get authentication, authorization, CRUD, cascade operations, and audit logging out of the box — then focus on your business logic.

Status: Pre-alpha. API is unstable and will change.

What you get

  • Zero-boilerplate CRUD — Define a model, get a complete REST endpoint with validation, pagination, filtering, and sorting
  • Authentication — JWT (ES512) with toggleable on/off, OAuth2 providers (Google, Microsoft, GitHub)
  • Feature-based authorization — Access groups with resource/attribute/data-level permissions
  • Cascade operations — Declarative delete (deny/null/delete) and update (subscriber pattern)
  • ETag concurrency control — Optimistic locking on all mutations
  • Audit trail — Every mutation logged automatically
  • Schema-driven admin/admin/schema endpoint powers the Craft Easy Admin app

Quick start

pip install craft-easy-api
from craft_easy import create_app
from craft_easy.crud import Resource
from craft_easy.models.user import User
from craft_easy.models.organization import Organization

app = create_app()

app.include_router(Resource(User, "users").build())
app.include_router(Resource(Organization, "organizations").build())
uvicorn app:app --reload
# API:     http://localhost:8000
# Docs:    http://localhost:8000/docs

Development

git clone https://github.com/easy-software-system/craft-easy-api.git
cd craft-easy-api
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
docker compose up -d    # Start MongoDB
pytest                  # Run tests

Documentation

Full documentation: craft-easy.dev (coming soon)

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

craft_easy_api-0.1.0.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

craft_easy_api-0.1.0-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file craft_easy_api-0.1.0.tar.gz.

File metadata

  • Download URL: craft_easy_api-0.1.0.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for craft_easy_api-0.1.0.tar.gz
Algorithm Hash digest
SHA256 643e14892c4fed6c3e8f297dae9fc00c0ab03a85e3b2217c8fac138cfe653792
MD5 baf623b843b9efa351b69dc967cd395a
BLAKE2b-256 2634dfae697b6e5d7a7841f0137e6015c89afb026c0db963a4b6e17ff88c9370

See more details on using hashes here.

File details

Details for the file craft_easy_api-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: craft_easy_api-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for craft_easy_api-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c750c7ac029c108ed3c666466332bb62d5af673f24ebdbd47e7e711f5e4ecb1d
MD5 cd809b573816e04737e806243471dd7b
BLAKE2b-256 b0a7676594389dec63f843949bbed709a173703b020482895780ddc6920df3c2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page