skills.rest
angga30
angga30COMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design-principles

Define and enforce consistent REST and GraphQL API design practices.

Updated Feb 19, 2026
Search Tags:#design#versioning#api#adr#rest#graphql
One-click install
npx skills add https://github.com/angga30/antigravity-skill-tech-lead --skill api-design-principles-angga30
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/angga30/antigravity-skill-tech-lead/tree/main/api-design-principles
Command: npx skills add https://github.com/angga30/antigravity-skill-tech-lead --skill api-design-principles-angga30

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

Design and enforce consistent REST and GraphQL API design across teams to prevent fragmented interfaces.

Core Features & Use Cases

  • Standardize API styles, versioning, pagination, and error handling across REST and GraphQL.
  • Provide templates and checklists for documentation, review, and migration planning.
  • Use Case: Onboarding teams to codified API design patterns and maintainable contracts.

Quick Start

Draft your API design guidance using ADR templates and the playbook to start applying consistent REST/GraphQL patterns across services.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
What are the core principles for REST and GraphQL API design?▼

Core API design principles standardize schema design, versioning, pagination, error handling, and authentication to prevent fragmented interfaces. Codifying these practices ensures maintainable contracts and consistent API behavior across new services and platform-wide migrations.

How do I standardize API versioning and pagination across multiple services?▼

Standardize API versioning and pagination by applying actionable templates and patterns during API design reviews. Enforcing consistent REST and GraphQL practices prevents fragmented interfaces and ensures platform-wide standards are maintained across service evolutions.

Does this API design guidance apply to both new services and legacy migrations?▼

Yes, this API design guidance applies to new services, migrations, and platform-wide evolutions. It codifies REST and GraphQL API design into checklists and templates to onboard teams to maintainable contracts and consistent interface standards.

What is the best way to document API design decisions for team onboarding?▼

The best way to document API design decisions is using ADR templates and a design playbook. Drafting guidance with these templates helps onboard teams to codified REST and GraphQL patterns, ensuring consistent API styles and maintainable contracts.

How do I enforce consistent error handling and authentication in my API?▼

Enforce consistent error handling and authentication by codifying them into actionable patterns and review checklists. Standardizing these API design practices across REST and GraphQL prevents fragmented interfaces and ensures robust, secure service contracts.

Related Skills

Explore More Software Engineering Skills→
HechaoYannetHechaoYannet

create-architecture

Generate a master architecture document from GDDs, ADRs, and governance constraints.

Community
Advanced
nahisahonahisaho
69

api-designer

Design RESTful, GraphQL, and gRPC APIs with OpenAPI and Protobuf definitions.

Community
Intermediate
radenadriradenadri

api-design-audit

Audit REST and GraphQL API designs for contracts, error handling, and documentation.

Community
Advanced
taewook486taewook486

openapi-to-application

Generate applications from OpenAPI specifications with code scaffolding.

Community
Advanced