skills.rest
OM-bit-hub
OM-bit-hubCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design RESTful API contracts with endpoints, schemas, and error handling.

Updated Aug 23, 2026
Search Tags:#design#versioning#documentation#api#endpoints#contracts#schemas
One-click install
npx skills add https://github.com/OM-bit-hub/daily_tracker --skill api-design-om-bit-hub
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/OM-bit-hub/daily_tracker/tree/main/.agents/skills/architect/api-design
Command: npx skills add https://github.com/OM-bit-hub/daily_tracker --skill api-design-om-bit-hub

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Design RESTful APIs from feature requirements to produce consistent contracts that specify endpoints, request/response schemas, error handling, and versioning, enabling reliable frontend-backend coordination and faster delivery.

Core Features & Use Cases

  • End-to-end API contract design from feature briefs to production-ready specs
  • Clear endpoint definitions, request/response schemas, validation rules, and error codes
  • Versioning strategy and deprecation planning for multiple API consumers
  • Use Case: turning a new feature into a complete API surface for frontend and backend teams to implement in parallel

Quick Start

Generate an API contract from a feature brief, including endpoints, schemas, and versioning guidelines.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a RESTful API contract from feature requirements?▼

To design a RESTful API contract, you translate feature requirements into endpoint definitions, request/response schemas, validation rules, and error codes. This ensures frontend and backend teams can implement against a consistent specification in parallel.

What is the best way to version RESTful API endpoints for multiple consumers?▼

The best way to version RESTful API endpoints is by applying a structured versioning strategy alongside deprecation planning. This accommodates multiple API consumers by maintaining backward compatibility while introducing new schema changes.

How do I plan API schemas and error handling for frontend-backend coordination?▼

You plan API schemas and error handling by defining clear request/response structures and standardized error codes within an API contract. This enables reliable frontend-backend coordination and faster delivery.

What standards should I follow for REST API pagination and UUID fields?▼

REST API pagination and UUID fields should follow project standards, utilizing camelCase for field naming. The contract design enforces these rules to satisfy design consistency across all endpoints.

Can I use this to redesign existing APIs instead of planning new endpoints?▼

Yes, you can apply the contract design to redesign existing APIs. It helps restructure current endpoint definitions, schemas, and error handling to align with updated project standards and versioning strategies.

When do I need to define API contracts for endpoint development?▼

You need to define API contracts when turning a new feature into a complete API surface. This provides a production-ready spec that allows independent development across teams without blocking dependencies.

Related Skills

Explore More Software Engineering Skills→
changgengluchanggenglu

api-designer

Define RESTful API designs and OpenAPI 3.0 specifications from user prompts.

Community
Advanced
Quanby-IT-SolutionsQuanby-IT-Solutions
2

orpc-contracts

Define API contracts and endpoints using oRPC contracts for NestJS and Next.js.

Official
Advanced
patricio0312revpatricio0312rev
5

api-docs-generator

Generate OpenAPI documentation and multi-language SDKs from YAML or JSON specifications.

Community
Advanced
Camilo8902Camilo8902

rest-to-graphql-migrator

Migrate REST APIs to GraphQL incrementally using schema stitching and REST data source wrappers.

Community
Advanced