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 para a instalação

Repositório: kwkraus/edgefront-builder
Última atividade na origem: 20 de maio de 2026 às 20:18
Idioma detectado do SKILL.md: inglês
Estrelas: 0
Forks: 0

Opções de instalação

Por padrão, está selecionado o prompt que primeiro revisa a origem. Você pode mudar para um comando direto ou baixar uma cópia local.

Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.

Um comando direto ignora o prompt de revisão. Verifique a origem antes de executá-lo.

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

O comando permanece em uma só linha. Role horizontalmente para revisá-lo antes de copiar.

Prefere uma cópia local? Baixe os arquivos disponíveis atualmente no SkillsMP.

Revise os arquivos de origem

Leia o SKILL.md e os arquivos complementares exibidos pelo SkillsMP antes de decidir se vai instalar.

SKILL.md

Instruções da origem · Visualização somente leitura

Voltar à pesquisa Voltar à instalação

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 todas deste repositório

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.