fastapi-amis-admin

The ModelAdmin manages data through four main lifecycle stages: Read, Create, Update, and List. The final configuration is determined by a priority system where explicit overrides (like get_list_display) take precedence over field definitions.

Data Flow Summary

• Read: Uses schema_read to produce ReadApiResponse. Field selection is driven by fields and exclude.
• Create: Uses schema_create and get_create_form to produce AmisCreateForm, which is then sent to the route_create endpoint.
• Update: Uses schema_update and get_update_form to produce AmisUpdateForm. Fields can be restricted via update_fields or made readonly_fields.
• List: Combines fields, list_display, and list_filter to build the TableCRUD view. Search functionality is driven by search_fields and get_list_filter_form.

The BaseAdmin class serves as the fundamental base class for page management within fastapi-amis-admin. When working with admin objects, you can access the following attributes:

• app: The AdminApp object that the current admin object is registered to. Note that app is not necessarily the top-level object and might be registered by another AdminApp or AdminSite.
• site: The AdminSite instance where the current management object is registered (the top-level Admin object).
• unique_id: A unique identifier for the management object.
  • You can customize this setting.
  • If not provided, it is automatically generated.
  • Requirement: Unique IDs must remain consistent when a project starts or stops and must be unique per Admin class within a single project.

The SQLModelSelector is used to select and filter fields from a SQLModel ORM model. When configuring a selector, you can specify which fields to include, which to exclude, and how to order them.

Key configuration options include:

• model: The SQLModel ORM model (required).
• fields: A list of fields to query. Supports current model fields or fields from other models. Defaults to self.model.
• exclude: A list of fields to exclude from the current model.
• ordering: A list of selectors to sort the field list.
• pk_name: The primary key string of the current model (defaults to id).
• pk: The SQLAlchemy InstrumentedAttribute for the primary key.

The ModelAdmin class is the primary way to manage model administration. You can inherit from BaseModelAdmin or specialized classes like PageAdmin or SQLModelCrud to implement management logic.

One key feature is bind_model. When bind_model=True (the default), the management page is automatically discoverable via AdminSite.get_model_admin. This is particularly useful for foreign key associations, as the default FormItem (using TablePicker) will automatically use the corresponding management page for the bound model.

While BaseAdminSite provides the core functionality, AdminSite is a specialized subclass designed for full-featured administrative sites. Unlike the base class, AdminSite automatically registers several administrative classes by default, including:

• HomeAdmin
• DocsAdmin
• ReDocsAdmin
• FileAdmin

Use AdminSite when you want a ready-to-use management interface with built-in documentation and file management capabilities.