Ejecuta cualquier Skill en Manus
con un clic

Ejecuta cualquier Skill en Manus con un clic

api-contract-design

Estrellas0

Forks0

Actualizado20 de mayo de 2026, 20:18

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.

Instalación

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.

Ejecutar en Manus

Fuente

kwkraus

kwkraus/edgefront-builder

Abrir repositorio de GitHub Ver repositorios del creador

Descarga

Ejecutar en Manus

Ocupaciones relacionadasSOC

Basado en la clasificación ocupacional SOC

Desarrolladores de softwareOcupaciones informáticas y matemáticas·SOC 15-1252

SKILL.md

readonly

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.

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.

Más de este repositorio

mismo repositorio

api-test-strategy

kwkraus/edgefront-builder

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-200

data-schema-migration

kwkraus/edgefront-builder

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-05-200

delegated-data-sync-pipeline

kwkraus/edgefront-builder

Design and implement the delegated Graph sync pipeline from fetch through normalization, upsert, and metrics recompute. Use for user-initiated registrations or attendance sync, idempotency, and atomic recomputation.

2026-05-200

deployment-safety-and-rollback

kwkraus/edgefront-builder

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-200

domain-metrics-computation

kwkraus/edgefront-builder

Apply email and domain normalization plus session and series metric rules, including W1/W2 warm-account logic and internal-domain exclusion. Use for domain logic changes, recompute behavior, and mandatory unit-test coverage.

2026-05-200

frontend-accessibility-and-ux-acceptance

kwkraus/edgefront-builder

Review Next.js interfaces for accessibility and UX acceptance. Use for semantic markup, keyboard flow, responsive behavior, async states, and final user-flow validation before merge.

2026-05-200

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.

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.