Home

>

Design to Code

>

API Development Studio

Step
2

API Development Studio

Overview
The API Development Studio helps in automating API scaffolding by generating:
CRUD (Create, Read, Update, Delete) operations for database entities.
Boilerplate code for various backend frameworks.
Supported Frameworks
Codespell currently supports:
Node.js
Golang
PHP (Symfony, Laravel)
.NET
Java

How It Works

Step 1: Selecting Framework & Database
Choose your backend framework.
Database (available options vary by language; currently supported: MySQL, PostgreSQL, and Microsoft SQL Server)
Step 2: Importing or Creating Database Schema
Option 1: Manual Table Creation  
Add tables and define relationships.
Fig 16: Demonstrates the framework and DB selection step.
Option 2: Import Existing Schema  
Upload SQL schema or import from an existing database.
Fig 17: Example of schema import via SQL.
Step 3: Reviewing the Entity Model
View all tables with their relationships, foreign keys, and constraints.
Fig 18: Visual preview of entity relationships before code generation.
Modify entities as needed.
Step 4: Generating API Code
Click Review & Generate.
Fig 19: Visual includes generating CRUD API boilerplate in-progress.
Codespell generates API endpoints, CRUD operations, and a starter boilerplate.
Fig 20: Last step in generating CRUD API boilerplate.
Step 5: Writing Business Logic
Developers extend the generated code by adding custom business logic.