dotnet-scaffold-api-server-models

Generate API model records implementing Umbrella shared interfaces for Web.Shared.Models.Api.

8|1|Updated Feb 5, 2018
One-click install
npx skills add https://github.com/umbrella-libraries/Umbrella --skill dotnet-scaffold-api-server-models
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dotnet-scaffold-api-server-models
Source: https://github.com/umbrella-libraries/Umbrella/tree/main/.ai-shared/skills/dotnet-scaffold-api-server-models
Command: npx skills add https://github.com/umbrella-libraries/Umbrella --skill dotnet-scaffold-api-server-models

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scaffold API model records for a new feature, following Umbrella's shared models pattern with optional base class hierarchies to centralize validation.

Core Features & Use Cases

  • Generates full read, slim read, create, update, create/update result, and paginated models per feature.
  • Enforces interface contracts (IKeyedItem<int>, IConcurrencyStamp, ICreateResultModel<int>, IUpdateModel<int>, IUpdateResultModel) and supports optional base class hierarchies for shared validation attributes.
  • Enables consistent naming and organization in Web.Shared.Models.Api for maintainability and reuse.

Quick Start

Run the scaffold tool to generate the API model records for the new feature in the shared models project.

Frequently Asked Questions about dotnet-scaffold-api-server-models

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

FAQPage Schema
How do I scaffold API models for a new .NET feature?

Scaffolding API models for a new .NET feature involves generating request and response records in Web.Shared.Models.Api. This tool creates Create, Update, Slim, and Paginated models while enforcing Umbrella's shared models pattern for consistent naming and organization.

What interfaces do .NET API models need for concurrency and validation?

API models require IKeyedItem<int>, IConcurrencyStamp, ICreateResultModel<int>, IUpdateModel<int>, and IUpdateResultModel interfaces. The scaffolding enforces these contracts and supports optional base class hierarchies to centralize shared validation attributes.

Can I use base class hierarchies to centralize validation in C# API models?

Yes, base class hierarchies can centralize validation in C# API models. The scaffolding supports optional base classes to apply shared validation attributes across Create, Update, Slim, and Paginated records, ensuring maintainability and reuse.

What's the best way to generate paginated and slim read models in dotnet?

Using a scaffold tool is the best way to generate paginated and slim read models in dotnet. It produces full read, slim read, create, update, result, and paginated records per feature, maintaining consistent organization in Web.Shared.Models.Api.

Does the dotnet API model scaffold work without external dependencies?

The dotnet API model scaffold operates without external dependencies. It generates model records implementing the required interfaces based on Umbrella's shared models pattern, requiring no additional packages to produce the API model structures.

Why do I need a concurrency stamp when creating API models in C#?

A concurrency stamp is needed when creating API models in C# to handle optimistic concurrency control. The scaffold ensures models implement IConcurrencyStamp, enabling safe concurrent updates and preventing data conflicts in Web.Shared.Models.Api.