Backend Code and API Generation Reference

This section explains how Avora turns workspace diagrams into generated backend code and API routes.

7. Code Generation

Code generation converts canvas entities, relationships, requests, and settings into a project structure.

7.1 Configuring the Generator

In the Code view, the right sidebar shows generation settings:

• Project Name: Used as the root package name
• Framework: FastAPI (Python) — Spring Boot coming soon
• Database: PostgreSQL or MongoDB
• Features: Auth is included by default

7.2 Generated Project Structure (FastAPI)

project_name/
├── app/
│   ├── main.py                    # FastAPI app entry, router inclusion
│   ├── core/
│   │   ├── config.py              # Pydantic settings from .env
│   │   ├── database.py            # SQLAlchemy engine + session
│   │   └── security.py            # JWT creation, password hashing
│   ├── models/
│   │   ├── enums.py               # SQLAlchemy Enum types
│   │   └── {entity}.py            # SQLAlchemy ORM model per entity
│   ├── schemas/
│   │   └── {entity}.py            # Pydantic schemas (Base, Create, Update, Response)
│   ├── services/
│   │   └── {entity}_service.py    # CRUD operations + relationship management
│   └── api/
│       ├── deps.py                # Auth dependency injection
│       └── v1/endpoints/
│           ├── auth.py            # Login, signup, refresh (if auth enabled)
│           └── {entity}.py        # Full CRUD router per entity
├── requirements.txt
├── .env
├── Dockerfile
├── docker-compose.yml
├── reset_db.py                    # Development DB reset utility
└── README.md

7.3 Relationship Handling in Generated Code

7.4 Auth Feature

When auth is enabled and a User entity exists, the generator automatically:

• Injects email, is_active, is_superuser fields if missing
• Creates a hashed_password column
• Generates JWT-based login, signup, and refresh-token endpoints
• Generates OAuth2PasswordBearer dependency for protected routes
• Creates Token and TokenPayload Pydantic schemas

7.5 Downloading & Deploying

• Generate & Preview: Renders files in the Monaco editor Code view — navigable via file tree
• ZIP Download: Full project as .zip archive
• Local Generate: Server writes files directly to a specified absolute path on the server machine
• Publish to GitHub: Creates a new private repository and pushes all files (requires GitHub OAuth connection)

7.6 Code Caching

Generated code is cached in-memory per workspace using a hash of the current node/edge state. If the diagram changes after generation, an "outdated" indicator appears with a pulsing orange dot prompting regeneration.

8. Requests View & API Design

The Requests view turns modeled entities into editable endpoint lanes and request nodes.

8.1 Lanes (GroupelineNode)

Each Class entity automatically gets a corresponding Lane in the Requests view. Lanes are vertical columns that group related API endpoints.

• Lane header shows the entity name and endpoint count
• Collapse/expand via the chevron button
• Drag to reorder lanes horizontally

8.2 CRUD Auto-Generation

When a new Class node is created, 5 default Request nodes are automatically generated:

8.3 Request Node Editing

• Click the method badge to change HTTP method
• Edit group, path, URL, and body inline
• Nodes are non-draggable (auto-positioned within their lane)
• Download a request as a curl .sh file via the Download action

9. Version Control

Versions let teams save, review, and restore snapshots of workspace state.

9.1 Saving Versions

Click Versions in the top header. Enter a version name (e.g., v1.0, pre-auth-refactor) and click Save. A snapshot of all nodes and edges is stored with author and timestamp metadata.

9.2 Restoring Versions

In the Versions panel, click the restore icon (↺) next to any saved version. This overwrites the current workspace state with the snapshot — all current changes are replaced.

9.3 Version History

Each version entry shows:

• Version name
• Creation date and time
• Created by (username)

14. API Reference (Backend)

Base URL: https://your-domain.com/api/v1

Authentication: Bearer token in Authorization header

Auth Endpoints:

Workspace Endpoints:

AI Endpoints:

Generator Endpoints:

WebSocket:

WS /api/v1/ws/{workspace_id}?token={jwt}

Messages: GRAPH_UPDATE, CURSOR_MOVE, STATUS, WORKSPACE_UPDATE, USER_LEFT