skills.rest
Ankurjain1121
Ankurjain1121COMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design-principles

Define REST and GraphQL API contracts in api-contracts.md before implementation.

1|Updated Jan 15, 2026
Search Tags:#planning#validation#GraphQL#REST#API design#contract-first
One-click install
npx skills add https://github.com/Ankurjain1121/dev-workflow-skills --skill api-design-principles-ankurjain1121
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/Ankurjain1121/dev-workflow-skills/tree/main/plugins/framework-dev/skills/api-design-principles
Command: npx skills add https://github.com/Ankurjain1121/dev-workflow-skills --skill api-design-principles-ankurjain1121

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

API design often drifts when teams work in parallel; this skill promotes contract-first API planning to ensure a single source of truth for endpoints, schemas, and integration rules.

Core Features & Use Cases

  • Contract-first design to align backend and frontend teams.
  • Supports REST and GraphQL patterns with explicit endpoint specs, schemas, and status tracking.
  • Use Case: When planning a framework's API surface, define api-contracts.md as the source of truth and validate implementations against it.

Quick Start

Create or update 03-api-planning/api-contracts.md as the single source of truth, then reference it to implement endpoints and client contracts.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
What is contract-first API design and why does it prevent drift?▼

Contract-first API design formalizes endpoints, schemas, and validation rules in a single source of truth file before implementation. This prevents integration drift by ensuring parallel frontend and backend teams validate work against a shared contract.

How do I plan REST and GraphQL APIs before implementation?▼

To plan REST and GraphQL APIs, define endpoint specifications, schemas, and status tracking in an api-contracts.md file. This formalizes the API surface during planning, enabling parallel frontend and backend development without misalignment.

Can I use contract-first API planning for both REST and GraphQL?▼

Yes, contract-first API planning applies to both REST and GraphQL designs during the planning phase. It explicitly supports defining endpoint specs, schemas, and validation rules for either protocol within a single source of truth file.

What's the best way to align frontend and backend teams during API development?▼

The best way to align teams is creating an api-contracts.md file as the single source of truth. By formalizing endpoint schemas and validation rules, parallel frontend and backend work can proceed against a verified contract.

How do I track endpoint status and verify API contracts?▼

You track endpoint status and verify API contracts by documenting them within the api-contracts.md file. This file serves as the single source of truth for endpoint specifications and supports contract verification and tooling guidance.

Related Skills

Explore More Software Engineering Skills→
cedricfarinazzocedricfarinazzo

agile-2-create-prd

Convert a validated Vision Doc into a structured Confluence PRD page.

Community
Intermediate
vuthuonghai-stevevuthuonghai-steve
1

api-integration

Generate frontend service methods and types from backend API definitions.

Community
Advanced
kevinnftkevinnft
13

api-testing

Automate REST and GraphQL API validation with pytest and JSON Schema.

Community
Intermediate
SaturateSaturate

api-design

Generate OpenAPI specs and TypeScript types from contract-first API designs.

Community
Advanced