api-contract-design

Design ASP.NET Core minimal API request and response contracts. Use for DTO shapes, route and verb decisions, OpenAPI metadata, and compatibility planning before implementation.

Ir a la instalación

Repositorio: kwkraus/edgefront-builder
Última actividad en el origen: 20 de mayo de 2026 a las 20:18
Idioma detectado de SKILL.md: inglés
Estrellas: 0
Forks: 0

Opciones de instalación

De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.

Instalar con Codex o Claude Copia este prompt, pégalo en Codex, Claude u otro asistente, y deja que revise la página de la skill y la instale por ti.

Un comando directo omite el prompt de revisión. Revisa el origen antes de ejecutarlo.

npx skills add https://github.com/kwkraus/edgefront-builder --skill api-contract-design

El comando permanece en una sola línea. Desplázate horizontalmente para revisarlo antes de copiarlo.

¿Prefieres una copia local? Descarga los archivos que SkillsMP tiene disponibles ahora.

Revisa los archivos de origen

Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.

SKILL.md

Instrucciones de origen · Vista previa de solo lectura

Volver a la búsqueda Volver a la instalación

data-schema-migration

Design EF Core schema changes, constraints, and migrations for the backend data model. Use for entity updates, indexes, uniqueness rules, cascade behavior, and migration planning.

2026-06-04

api-test-strategy

Define focused tests for ASP.NET Core minimal APIs. Use for endpoint branch coverage, contract assertions, regression planning, and choosing the narrowest useful verification command.

2026-05-20

deployment-safety-and-rollback

Define deployment safeguards, environment protections, and rollback readiness for CI/CD releases. Use when adding or reviewing release jobs, promotion controls, or recovery plans.

2026-05-20

Ver todos los de este repositorio

API Contract Design

When to Use

New minimal API endpoints in src/backend

Changes to request/response DTOs

OpenAPI contract clarification before implementation

Backward-compatibility decisions for existing clients

Quick Checklist

Confirm route + verb match resource intent.

Define request/response DTOs (no domain entities).

Map each branch to status + payload shape.

Mark compatibility impact (additive/soft-breaking/hard-breaking).

Inputs to Gather

Route and verb (GET, POST, PUT, PATCH, DELETE)

Resource model and operation intent

Required vs optional fields

Success and failure response variants

Compatibility constraints (breaking vs additive)

Deep Workflow

Define endpoint intent in one sentence and choose resource-oriented route shape.

Draft request and response DTOs as records/classes; never expose domain entities.

Add explicit field semantics (required, nullable, defaults, allowed ranges/enums).

Map each response variant to a concrete HTTP status and payload shape.

Verify contract coherence with minimal API metadata and OpenAPI output expectations.

Confirm whether the change is additive, soft-breaking, or hard-breaking.

Decision Points

If operation mutates state, include idempotency expectations.

If partial update is needed, decide PATCH semantics and null-handling behavior.

If conflicts are possible, include a deterministic conflict response contract.

Completion Checks

Request/response DTOs are explicit and serialization-safe.

No domain entity types appear in public API signatures.

Every documented status code has a defined payload contract.

Route, verb, and DTO names align with resource intent.

name	api-contract-design
description	Design ASP.NET Core minimal API request and response contracts. Use for DTO shapes, route and verb decisions, OpenAPI metadata, and compatibility planning before implementation.
argument-hint	Describe the endpoint purpose, route and verb, request fields, response variants, and compatibility constraints.