What is the Design to code?
The Design to code in Codespell, also known as the Design to Code workspace—is an AI-powered development environment that enables developers to automate boilerplate API generation, API test script creation, and Infrastructure as Code (IaC) setup. It accelerates project delivery by transforming structured designs, specifications, or plain English instructions into ready-to-use code with minimal manual effort.
Who Can Use It?
.svg)
Pro License Users Only: The Design to code is available exclusively for Codespell users with a Pro subscription.
The Design to code helps developers automate API generation, automated API test script creation, and infrastructure setup. It includes three key areas:
What Can You Do with Design to code?
Generate boilerplate API code from a database schema.
Converts OpenAPI specs, Swagger docs, or plain English instructions into structured test scripts.
Create Terraform scripts for cloud infrastructure deployment.
Introduction to Design to code
Accessing the Design to code
How to Navigate to Design to code
There are two ways to access the Design to code:
From the Codespell Sidebar: Click the Design to code icon in the main navigation panel.
From the Codespell Context Menu: Right-click within your IDE → Select "My Projects" → Navigate to the Design to code tab.
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.
Test Script Development Studio
Overview
This studio helps in automating test case generation using:
Fig 21: Shows both test case input methods.
Manual test cases in Excel format
How It Works
Step 1: Uploading Test Cases
Option 1: Import OpenAPI Spec
Fig 22: Accessing OpenAPi Specs window
Option 2: Upload Excel Test Cases
Fig 23: Demonstrates uploading of test cases
Step 2: Reviewing & Modifying Test Cases
View, edit, or delete test cases inline.
Fig 24: Interface for modifying imported test cases.
Add new test cases manually.
Fig 25: Visual of the Design to Code workspace showing all existing projects by name, type, and creation date.
Step 3: Generating Automated Test Scripts
Click Review & Generate.
Fig 26: A full of the window the summary before code generation
Codespell generates automated test scripts.
Fig 27: Here is a full of the code being generated
Infrastructure as Code (IaC) Studio
Overview
The IaC Studio helps DevOps teams create Terraform scripts for cloud infrastructure deployment.
Supported Cloud Providers
AWS (Currently Supported)
Future support for Azure and Google Cloud is planned.
How It Works
Step 1: Configuring Infrastructure
Define environmental details (e.g., region, resources).
Fig 28: Screen with options to edit project details
Specify cloud services (e.g., S3, EC2, RDS).
Fig 29: Project screen without components
Step 2: Generating Terraform Scripts
Click Review & Generate.
Fig 30: Screen with options to generate terraform scripts
Codespell creates a Terraform script for deployment.
Fig 31: Full view of generated terraform scripts
Team Collaboration in Design to code
Single-User Editing: Only one developer can edit a project at a time.
View Mode for Others: If a second developer opens the same project, they get read-only access.
Editable After First User Closes: Once the original user closes the project, another team member can edit it.
.svg)