skills.rest
a53ali
a53aliCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Guide REST and GraphQL API design with versioning and resource naming.

Updated Mar 15, 2026
Search Tags:#api design#rest#graphql#rest api#api versioning
One-click install
npx skills add https://github.com/a53ali/ai-dev --skill api-design-a53ali
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/a53ali/ai-dev/tree/main/skills/engineer/api-design
Command: npx skills add https://github.com/a53ali/ai-dev --skill api-design-a53ali

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill ensures the creation of robust and maintainable APIs, mitigating common pitfalls and facilitating growth with a stable foundation.

Core Features & Use Cases

  • API Design Guidance: Provides comprehensive principles for designing REST and GraphQL APIs.
  • Endpoint Design Best Practices: Offers specific guidance on resource naming, HTTP methods, and status codes.
  • API Versioning Strategy: Suggests best practices for managing API versions to minimize disruption.
  • Use Case: When planning to introduce a new REST API to handle orders within your application.

Quick Start

Utilize the api-design skill to design your next API endpoint by specifying its intended purpose.

Frequently Asked Questions about api-design

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

FAQPage Schema
What are the best practices for REST API resource naming and HTTP methods?▼

REST API resource naming and HTTP method best practices involve using logical resource models, standard HTTP verbs, and correct status codes to ensure endpoints remain predictable, maintainable, and robust over time.

How do I design a REST API for long-term stability and scalability?▼

Designing a REST API for long-term stability requires applying principles like idempotency, structured resource naming, and strategic API versioning to mitigate common pitfalls and facilitate scalable growth.

When should I use GraphQL instead of a REST API for my application?▼

Choosing GraphQL or REST API depends on your evolution needs; this API design guidance provides comprehensive principles for structuring both architectures, helping you decide based on resource models and endpoint requirements.

What is the best API versioning strategy to minimize client disruption?▼

The best API versioning strategy minimizes disruption by systematically managing breaking changes across versions, ensuring long-term stability for existing clients while allowing the API to evolve and scale safely.

How do I structure an API endpoint list and resource models for handling orders?▼

Structuring API endpoint lists and resource models for orders involves defining resource names, applying idempotency principles, and using industry-recognized models as references to output a stable, scalable endpoint architecture.

Related Skills

Explore More Software Engineering Skills→
guichefferguicheffer
3

data-transformation

Transform raw API responses into structured domain models with dedicated functions.

Community
Intermediate
EstomEstom

api-designer

Design REST and GraphQL APIs and generate OpenAPI 3.1 specifications.

Community
Advanced
roanbrasilroanbrasil
5

api-gateway-design

Configure API gateways with authentication, rate limiting, and routing.

Community
Advanced
seantempestaseantempesta
1

data-modeling

Design and register Malli data schemas with runtime validation and database attributes.

Community
Advanced