skills.rest
hodinhtuankiet
hodinhtuankietCOMMUNITY
Explore all skills by this author →
GitHub

api-and-interface-design

Define stable, well-documented interfaces for REST, GraphQL, and internal boundaries.

Updated Aug 23, 2026
Search Tags:#versioning#api#rest#graphql#contract-first#interface-design
One-click install
npx skills add https://github.com/hodinhtuankiet/screening-resume-recruitment --skill api-and-interface-design-hodinhtuankiet
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-and-interface-design
Source: https://github.com/hodinhtuankiet/screening-resume-recruitment/tree/main/.claude/skills/api-and-interface-design
Command: npx skills add https://github.com/hodinhtuankiet/screening-resume-recruitment --skill api-and-interface-design-hodinhtuankiet

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Design stable, well-documented interfaces for APIs, modules, and cross-team boundaries to prevent misuse.

Core Features & Use Cases

  • Establish contract-first design guidelines for REST, GraphQL, and internal module boundaries.
  • Define naming conventions, error semantics, and versioning practices to reduce breaking changes.
  • Provide actionable patterns for interface boundaries between frontend and backend and between modules.

Quick Start

Provide a clearly defined API contract skeleton for a new service and iterate on the schema before implementation.

Frequently Asked Questions about api-and-interface-design

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

FAQPage Schema
How do I design stable API contracts to prevent misuse across teams?▼

Contract-first design establishes an API schema before implementation, ensuring all teams align on boundaries. You define naming conventions, error semantics, and versioning upfront, then iterate on the schema skeleton to enforce forward-compatible changes and prevent misuse.

When do I need explicit versioning guidelines for REST and GraphQL APIs?▼

Explicit versioning guidelines are needed when evolving REST and GraphQL APIs to ensure forward-compatible changes. They define how to safely modify cross-team boundaries and internal modules, reducing breaking changes and maintaining stable API contracts for all consumers.

What is the best way to enforce consistent error semantics in interface design?▼

The best way to enforce consistent error semantics is through contract-first interface design. By defining error semantics, naming conventions, and versioning practices upfront in the API schema, you ensure stable, well-documented interfaces and prevent misuse across teams.

Can I use contract-first design for internal module boundaries and not just external APIs?▼

Yes, contract-first design applies to internal module boundaries and cross-team contracts, not just external APIs. Defining stable interfaces and explicit versioning guidelines for internal boundaries prevents misuse and ensures forward-compatible changes within the system.

Related Skills

Explore More Software Engineering Skills→
hadimiftahulfhadimiftahulf

business-analyst

Extracts and documents business logic, domain models, and workflows from a codebase.

Community
Intermediate
HouseGarofaloHouseGarofalo
3

openapi-swagger

Design, document, and generate APIs from OpenAPI and Swagger specifications.

Official
Advanced
cin12211cin12211
218

rest-api-expert

Design REST APIs with resource models, versioning, error handling, and OpenAPI documentation.

Community
Basic
HellKaiser45HellKaiser45

api-and-interface-design

Enforce contract-first design for REST APIs and GraphQL schemas.

Community
Intermediate