abp-contract-scaffolding

Generate ABP Application.Contracts interfaces, DTOs, and permissions from technical design.

24|5|Updated Nov 28, 2025
One-click install
npx skills add https://github.com/thapaliyabikendra/ai-artifacts --skill abp-contract-scaffolding
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: abp-contract-scaffolding
Source: https://github.com/thapaliyabikendra/ai-artifacts/tree/main/.claude/skills/abp-contract-scaffolding
Command: npx skills add https://github.com/thapaliyabikendra/ai-artifacts --skill abp-contract-scaffolding

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the initial phase of ABP Framework development by generating the Application.Contracts layer. It enables parallel development workflows, allowing backend and QA engineers to work concurrently on implementation and testing, significantly reducing overall feature delivery time.

Core Features & Use Cases

  • Interface-First Generation: Automatically scaffolds service interfaces (IAppService), DTOs (Create, Update, Output, List), and permission constants.
  • Parallel Development Enablement: Facilitates a workflow where abp-developer implements against defined interfaces while qa-engineer writes tests, all before the backend implementation is complete.
  • Standardized API Contracts: Ensures consistent and well-defined API contracts, improving clarity and reducing integration issues.
  • Use Case: A backend architect uses this skill to quickly define the API surface for a new module, generating all necessary contract files for a team of developers to begin parallel implementation and testing.

Quick Start

Generate ABP contract scaffolding for a new 'Product' entity, including its application service interface, DTOs, and permissions.

Frequently Asked Questions about abp-contract-scaffolding

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

FAQPage Schema
How do I generate ABP Application.Contracts layer scaffolding for parallel development?

Contract-first scaffolding for ABP generates interface definitions, DTOs, and permission constants from technical design, enabling backend developers and QA engineers to work simultaneously before implementation completes.

What DTOs and interfaces does ABP contract generation create?

ABP contract scaffolding produces strongly-typed service interfaces (I{Entity}AppService), input DTOs (GetListInput, Create{Entity}Dto, Update{Entity}Dto), output DTOs ({Entity}Dto), and permission constant definitions following ABP framework conventions.

Can I use contract-first design to speed up ABP module development?

Yes. Defining API contracts upfront lets your team parallelize implementation and testing workflows, reducing overall feature delivery time by establishing clear interface boundaries before backend work begins.

Do I need technical design documents to use ABP scaffolding?

Contract scaffolding is applicable in backend-architected workflows where technical design guides interface generation; it works best when your architecture and API surface are documented before code generation starts.

Why should I generate standardized ABP contracts instead of writing them manually?

Template-based contract generation ensures consistency with ABP conventions, reduces integration issues, and accelerates initial development by automating repetitive interface and DTO definitions across your application layer.