SWAIN – Visual Platform for Instant Backend Generation
Documentation for the SWAIN platform – a visual platform for instant backend generation.
Introduction
This chapter contains introductory sections for the SWAIN platform documentation.
Overview
SWAIN is a visual platform-as-a-service that transforms your database into a complete REST API th...
Key Features
Zero-Boilerplate CRUD Endpoints: Instant RESTful API generation for each data model or table. A...
How It Works
The SWAIN platform provides a seamless visual workflow for generating production-ready backends. ...
Use Cases & Stories
Rapid Prototyping: SWAIN allows startup founders and product teams to quickly validate ideas by...
Getting Started
Introduction to SWAIN capabilities and prerequisites.
What You Can Build
SWAIN enables you to build a variety of API capabilities: Database Integration – A fully featu...
Prerequisites
Before getting started with SWAIN, make sure you have: Database Access – Credentials for your ...
Workflow Overview
SWAIN projects follow a clear workflow consisting of several steps: Create Project – Define a ...
Setup Steps
This chapter outlines the step-by-step process for setting up your SWAIN backend, covering projec...
Create Project
https://drive.google.com/file/d/1_rwM1z95J_GWs33ICc4Yfu7hroKv1vXy/view?usp=drive_linkGo to Proj...
Create Connection
Navigate to Project → Connections → New Connection in the SWAIN dashboard. Fill in the connect...
Sync Schema
Open your database connection and click Sync Schema to scan your schema. SWAIN will import met...
Authentication Settings
General Security: Set Access Token Expiry (e.g., 1h) to control how long JWT access tokens r...
User Mapping
Map User Table: Identify which table in your database stores user accounts. Map the key col...
Social Auth
Enable social authentication so users can log in using providers like Google or GitHub. Regist...
Authorization
Go to the Authorization section in your project to manage roles and permissions. Create Roles ...
Deploy API
Once your project is configured (schema synced, authentication set up, user mapping, social aut...
Authentication
This chapter explains the authentication endpoints provided by SWAIN for login, signup, token man...
Additional
This chapter covers additional tools and resources for SWAIN, including the command-line interfac...
Swain CLI
Quick Start Install once, generate everywhere. Install: pipx install swain_cli (Python 3....
Testing
Use an API client like Postman to manually test each generated endpoint and verify it returns t...
Troubleshooting
If database connections fail, verify the host, port, database name and credentials, and ensure ...
The Query Builder
Security
This chapter outlines best practices for securing your SWAIN backend, including recommendations f...
Glossary
This chapter provides definitions for common terms and concepts used in SWAIN, such as row-level ...