design-api

Generate Markdown API specifications with request/response models and pseudocode.

Updated Feb 11, 2026
One-click install
npx skills add https://github.com/ureca-corp/claude --skill design-api-ureca-corp
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-api
Source: https://github.com/ureca-corp/claude/tree/main/plugins/domain-book-builder/skills/4-design-api
Command: npx skills add https://github.com/ureca-corp/claude --skill design-api-ureca-corp

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the creation of detailed API specifications, ensuring clarity and accuracy in request/response structures and complex logic.

Core Features & Use Cases

  • API Specification Generation: Automatically generates api-spec.md files based on domain models and session data.
  • Request/Response Modeling: Defines precise fields, types, requirements, examples, and validation rules for API inputs and outputs.
  • Pseudocode Generation: Creates clear, step-by-step pseudocode for complex API logic, adhering to strict formatting guidelines.
  • Use Case: When designing a new user management system, use this Skill to define the exact request and response formats for user creation, profile updates, and deletion, including handling cascade effects.

Quick Start

Use the design-api skill to generate the api-spec.md for the 'users' domain.

Frequently Asked Questions about design-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate detailed API specifications from domain models?

You can generate detailed API specifications by processing domain names, session data, and domain models to automatically produce an `api-spec.md` file. This file includes comprehensive API lists, precise request/response models, and step-by-step pseudocode for complex logic.

What is the best way to document request and response models for an API?

The best way to document request and response models is to define precise fields, data types, validation rules, requirement statuses, and error messages. This ensures strict formatting and clarity for API inputs and outputs within a single Markdown specification document.

How do I write pseudocode for complex API logic using domain-driven design?

You can generate pseudocode for complex API logic by applying domain-driven design principles to your domain models. The system creates clear, step-by-step pseudocode that adheres to strict formatting guidelines while filtering out unnecessary technical jargon.

Does API specification generation work without predefined domain models?

No, predefined domain models and session data are required inputs. The specification generation process relies on these inputs to accurately define request/response structures, field validation rules, and the pseudocode required for handling complex domain logic.

How to include validation rules and error messages in API documentation?

To include validation rules and error messages, generate your API documentation with strict field formatting. The output Markdown file enforces precise definitions for field types, requirements, validation constraints, and error messaging to ensure complete API clarity.