skills.rest
AZidan
AZidanCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

archflow-agent-api-contract-architect

Creates API contract specifications that frontend and backend engineers implement against.

28|4|Updated Mar 12, 2026
Search Tags:#rest api#api documentation#api contract#endpoint specification#frontend backend integration#release scoping#archflow
One-click install
npx skills add https://github.com/AZidan/archflow --skill archflow-agent-api-contract-architect-azidan
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: archflow-agent-api-contract-architect
Source: https://github.com/AZidan/archflow/tree/main/adapters/generic/.agents/skills/archflow-agent-api-contract-architect
Command: npx skills add https://github.com/AZidan/archflow --skill archflow-agent-api-contract-architect-azidan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Frontend and backend teams often drift apart because they build against assumptions instead of a shared specification, causing integration failures discovered late in development. This Skill produces a single authoritative API contract that both sides implement against with zero tolerance for deviation. ## Core Features & Use Cases - Structured Contract Authoring: Defines each endpoint with path, HTTP method, request parameters, typed fields, and success/error response examples in a consistent Markdown format. - Configurable Contract Location: Reads api_contract_path from .archflow/project-settings.yaml so the contract lands where the project expects it, defaulting to docs/api-contract.md. - Scoped, Append-Only Updates: Limits contract work to the active release and appends per-story sections without rewriting or dropping existing endpoints. - Use Case: During Archflow Phase 2.5, after wireframes are approved, generate the full API contract for the current release so api-engineer and ui-engineer can build in parallel without integration mismatches. ## Quick Start Ask the agent to create the API contract for the current release's stories and write it to the configured api_contract_path.

Frequently Asked Questions about archflow-agent-api-contract-architect

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

FAQPage Schema
How do I create an API contract for frontend and backend teams?▼

Define each endpoint with its path, HTTP method, typed request parameters, and example success and error responses in a single Markdown document. Both teams then implement against that document as the single source of truth, eliminating integration ambiguity.

What should an API contract specification include?▼

Include the endpoint path and HTTP method, parameter names with types and required/optional status, request body structure, success responses with realistic example values, and error responses with specific error codes. Exclude implementation details, database schemas, and business logic.

Where does the API contract file get written?▼

The contract is written to the path configured in `api_contract_path` inside `.archflow/project-settings.yaml`. If that field is unset, it defaults to `docs/api-contract.md`. The path is resolved once at the start and used consistently.

When in the development process should the API contract be created?▼

Create it in Archflow Phase 2.5, after wireframes are approved and before any implementation begins. The contract must be approved before Phase 3, since both engineers build against it with zero tolerance for deviation.

Can the API contract be modified after stories are completed?▼

The contract is append-only per story: new endpoints are added for the active release, but existing sections are never rewritten or dropped. Endpoints for backlog stories outside the active release are never contracted.

Related Skills

Explore More Software Engineering Skills→
wtthorntonwtthornton
4

designer

Design API contracts, data models, and UI/UX specifications.

Community
Advanced
parisgroup-aiparisgroup-ai
1

team-execute

Execute implementation plans across a coordinated multi-agent team pipeline.

Official
Advanced
HCMUTE-RTICHCMUTE-RTIC

api-testing-observability-api-mock

Create mock API services with FastAPI, Faker, and Pydantic.

Official
Advanced
EngineerWithAIEngineerWithAI
4

openapi-spec-generation

Generate, maintain, and validate OpenAPI 3.1 specifications for RESTful APIs.

Official
Advanced