A high-level software architect skill for designing business solutions, technical workflows, and production-ready backend interfaces.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install jinyun
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install jinyun using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Backend API Designer?
The Backend API Designer is an expert-level tool within the Openclaw Skills ecosystem designed for senior software architects and backend developers. It bridges the gap between raw business requirements and technical implementation by providing structured engineering analysis, architectural blueprints, and detailed interface definitions. Whether you are starting a project from scratch or refactoring an existing system, this skill ensures consistency across your technical stack.
This skill excels at synthesizing complex business logic into actionable developer artifacts. It natively supports Go-style proto definitions for gRPC/HTTP services and follows industry best practices for relational database modeling. By leveraging this component of Openclaw Skills, teams can maintain high standards for system design, including state machine logic and comprehensive sequence tracking for microservices interaction.
Backend API Designer Use Cases
- Analyzing existing codebases to document project structure and interface styles.
- Designing comprehensive business solution documents from high-level requirements.
- Generating Mermaid.js diagrams for flowcharts, state machines, and system architectures.
- Architecting gRPC and RESTful API contracts using Go-style proto specifications.
- Creating optimized MySQL database schemas with standardized audit fields and indexing.
How Backend API Designer Works
- Project Analysis: The skill scans the provided directory to identify directory structures, naming conventions, and existing tech stacks using CLI commands.
- Requirement Decomposition: It breaks down business goals into core entities, user roles, and boundary conditions.
- Visual Modeling: Utilizing Mermaid syntax, it generates visual representations of logic flow, entity relationships (ERD), and sequence diagrams.
- Interface Contract Definition: Based on the analyzed style, it generates .proto files and API service definitions.
- Data Layer Mapping: It produces DDL (Data Definition Language) SQL scripts for MySQL, ensuring consistent primary keys and timestamping.
Backend API Designer Setup
To integrate this designer into your workflow, ensure your environment is prepared for project scanning and documentation rendering:
# Example of how the agent might scan your local project structure
find . -type f -name "*.proto" | head -20
find . -type f -name "*.sql" | head -20
find . -type f -name "*.go" | head -30
Ensure you have a Markdown viewer that supports Mermaid.js rendering to visualize the generated diagrams within Openclaw Skills.
Backend API Designer Data Schema & Taxonomy
The Backend API Designer organizes output into structured reports and technical files. Below is the metadata and file taxonomy used:
| Component | Format | Purpose |
|---|---|---|
| Business Plan | Markdown | Summary of goals, scope, and technical stack |
| Flowcharts | Mermaid | Visual logic for business processes and decisions |
| API Contracts | .proto | gRPC/HTTP interface definitions (v1 style) |
| Database | SQL | MySQL InnoDB table structures with snake_case naming |
| State Maps | Mermaid | Entity state transition diagrams and triggers |
Backend API Designer Advanced Features
- Multi-Diagram Support: Generates Flowcharts, State Diagrams, Sequence Diagrams, C4 Architecture views, and ER Diagrams in a single pass.
- Automated Structural Analysis: Automatically detects project layers and module partitions to provide tailored design suggestions.
- Standardized SQL Templates: Enforces production-ready defaults like BIGINT UNSIGNED primary keys, soft deletes (deleted_at), and automatic timestamping.
- Pattern Integration: Leverages reference patterns for common business scenarios and architectural styles within the Openclaw Skills framework.
SKILL.md
Loading
Related Openclaw Skills
GPU Helper
A comprehensive offline reference tool for GPU development, covering everything from initial quickstarts to advanced performance patterns.
Privacy Compliance Assistant
An automated privacy expert that generates professional Privacy Impact Assessments, DPO reports, and compliance roadmaps based on your organization's data profile.
JS Compiler Reference
A comprehensive, zero-dependency reference tool providing instant documentation for JavaScript compiler concepts and implementation patterns.
Load Tester Reference Tool
A local, zero-dependency reference guide for developers to quickly lookup load testing concepts, patterns, and performance best practices.
Take The Wheel
A proactive leadership skill that enables AI agents to take control of the workflow by interviewing the user to complete complex tasks.
Real-time Weather & Forecast Agent
An automated weather tracking skill that uses browser navigation to fetch real-time forecasts and localized meteorological data.
Featured*
