flarchitect
=========================================

.. toctree::
   :maxdepth: 2
   :caption: Getting Started
   :hidden:

   feature_overview
   installation
   quickstart
   getting_started

.. toctree::
   :maxdepth: 2
   :caption: User Guide
   :hidden:

   models
   filtering
   joining
   custom_serialization
   grouping
   authentication
   auth_cookbook
   validation
   extensions
   plugins
   websockets
   manual_routes
   openapi
   graphql
   error_handling
   hooks_cheatsheet

.. toctree::
   :maxdepth: 2
   :caption: Configuration
   :hidden:
   
   configuration
   rate_limiting
   caching
   response_metadata
   advanced_configuration


.. toctree::
   :maxdepth: 2
   :caption: Advanced Topics
   :hidden:

   advanced_demo

.. toctree::
   :maxdepth: 2
   :caption: Developer Tooling
   :hidden:

   mcp_server
   llms.txt </llms.md>

.. toctree::
   :maxdepth: 2
   :caption: Project Info
   :hidden:

   faq
   troubleshooting
   roadmap

.. image:: /_static/coverage.svg
   :alt: Coverage Report

.. image:: https://github.com/lewis-morris/flarchitect/actions/workflows/run-unit-tests.yml/badge.svg?branch=master&event=push
   :alt: Tests

.. image:: https://img.shields.io/pypi/v/flarchitect.svg
   :alt: PyPI Version
   :target: https://pypi.org/project/flarchitect/

.. image:: https://img.shields.io/github/license/lewis-morris/flarchitect
   :alt: GitHub License

.. image:: https://badgen.net/static/Repo/Github/blue?icon=github&link=https%3A%2F%2Fgithub.com%2Flewis-morris%2Fflarchitect
   :alt: GitHub Repo
   :target: https://github.com/lewis-morris/flarchitect



--------------------------------------------


**Build APIs fast, customise at will.**

**flarchitect** turns your `SQLAlchemy`_ models into a polished RESTful API complete with interactive `Redoc`_ or Swagger UI documentation.
Hook it into your `Flask`_ application and you'll have endpoints, schemas and docs in moments. It reduces boilerplate while letting you tailor behaviour to your needs.

What can it do?

* Automatically create CRUD endpoints for your SQLAlchemy models.
* Generate `Redoc`_ or Swagger UI documentation on the fly - no manual OpenAPI spec needed.
* Be configured globally in `Flask`_ or per model or method via ``Meta`` attributes in your models.
* Authenticate users with minimal effort - use JWTs, API keys or Basic Authentication.
* Restrict endpoints to specific roles with :ref:`roles-required`.
* Extend behaviour with response callbacks, custom validators and per-route hooks (:ref:`advanced-extensions`).
* And much more!

Advanced Configuration
----------------------

Need finer control? The :doc:`Advanced Configuration <advanced_configuration>` guide covers features like rate limiting, CORS, and custom cache backends.

Want to see **flarchitect** in action? Define your models, plug the library into your `Flask`_ app, and you'll get CRUD endpoints, schemas, and interactive docs instantly. The :doc:`Quick Start <quickstart>` walks through a complete example.

`View Demos <https://github.com/lewis-morris/flarchitect/tree/master/demo>`__