skills.rest
RepairYourTech
RepairYourTechCOMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Enforce REST and GraphQL API design principles for naming, status codes, and versioning.

6|1|Updated Feb 27, 2026
Search Tags:#api design#rest#developer experience#graphql#api standards#api review
One-click install
npx skills add https://github.com/RepairYourTech/cfsa-antigravity --skill api-design-principles-repairyourtech
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/RepairYourTech/cfsa-antigravity/tree/main/.agent/skills/api-design-principles
Command: npx skills add https://github.com/RepairYourTech/cfsa-antigravity --skill api-design-principles-repairyourtech

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps you design and review APIs that are intuitive, scalable, and maintainable, ensuring a positive developer experience.

Core Features & Use Cases

  • API Design Standards: Establishes clear rules for REST and GraphQL API design.
  • Design Review: Provides a checklist to ensure API specifications meet best practices.
  • Use Case: When designing a new microservice API, use this Skill to ensure your endpoints, error handling, and data structures follow established best practices for consistency and ease of use.

Quick Start

Use the api-design-principles skill to review the provided API specification against best practices.

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 designing a scalable REST API?▼

REST API design principles enforce rules for resource naming, HTTP method semantics, and status code usage to ensure discoverability, scalability, and maintainability. Following these standards creates an intuitive interface and positive developer experience.

How do I structure error responses and pagination in a GraphQL API?▼

Structuring GraphQL API error responses and pagination involves applying established design standards for consistency and maintainability. Enforcing these rules during design or review ensures data structures follow best practices for developer experience.

What is the best way to review an existing API specification for best practices?▼

The best way to review an API specification is checking it against a design review checklist covering resource naming, error handling, and versioning strategies. This process ensures endpoints meet established API design standards for consistency.

Can I use this approach for both new microservice development and existing API reviews?▼

Yes, this approach supports both new API development and existing API reviews. It guides the design of REST and GraphQL APIs by enforcing core principles to ensure endpoints, error handling, and data structures follow best practices.

What API versioning strategies should I use for maintainability?▼

API versioning strategies for maintainability are evaluated as part of comprehensive design standards. Addressing versioning alongside resource naming and pagination ensures long-term scalability and a consistent developer experience across API iterations.

Related Skills

Explore More Software Engineering Skills→
coreindustriescoreindustries
1

api

Design, scaffold, and document RESTful and GraphQL APIs with OpenAPI schemas.

Community
Intermediate
HouseGarofaloHouseGarofalo
3

openapi-swagger

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

Official
Advanced
mymx2mymx2
4

ci-cd-and-automation

Configure GitHub Actions workflows to enforce quality gates on pull requests.

Community
Advanced
Intense-VisionsIntense-Visions
18

harness-api-design

Generate versioned OpenAPI, GraphQL, or proto specifications from existing API surfaces.

Official
Advanced