skills.rest
Emmraan
EmmraanCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Guide AI agents through API design from consumer needs to versioning.

Updated Mar 14, 2026
Search Tags:#api design#rest#developer experience#graphql#api architecture#grpc
One-click install
npx skills add https://github.com/Emmraan/agent-skills --skill api-design-emmraan
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Emmraan/agent-skills/tree/main/skills/api-design
Command: npx skills add https://github.com/Emmraan/agent-skills --skill api-design-emmraan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a comprehensive framework for designing APIs that are not only functional but also intuitive, consistent, and maintainable, ensuring they meet consumer needs and business objectives throughout their lifecycle.

Core Features & Use Cases

  • End-to-End API Lifecycle Guidance: Covers everything from initial consumer discovery and resource modeling to error handling, security, and versioning.
  • Style Selection & Justification: Helps choose the right API style (REST, GraphQL, gRPC, etc.) based on specific use cases and provides clear reasoning.
  • Detailed Design Specifications: Generates explicit resource models, URL structures, request/response schemas, and error formats.
  • Use Case: Designing a new public-facing e-commerce API, ensuring it's secure, scalable, and easy for third-party developers to integrate with.

Quick Start

Use the api-design skill to design a REST API for managing user profiles, including endpoints for creating, retrieving, updating, and deleting users.

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 REST API that is intuitive and consistent for third-party developers?▼

To design a consumer-friendly REST API, start by modeling resources and defining clear URL structures, request/response schemas, and standard error handling to ensure consistency and maintainability throughout the API lifecycle.

What is the best way to choose between REST, GraphQL, and gRPC for my API architecture?▼

Choosing the right API architecture involves evaluating specific consumer needs and use cases to justify the selected style, ensuring the design supports REST, GraphQL, or gRPC based on the required data fetching and communication patterns.

How do I establish robust error handling, authentication, and versioning strategies for a new API?▼

Establish robust API error handling, authentication, and versioning by defining explicit error formats and security protocols during the detailed design specification phase, ensuring designs are implementable and maintainable.

Can I use this API design process for a scalable public-facing e-commerce API?▼

Yes, this API design process guides the creation of secure, scalable public-facing e-commerce APIs by covering end-to-end lifecycle guidance from initial consumer discovery to detailed resource modeling and security implementation.

Does API architecture design require understanding consumer needs before modeling resources?▼

Yes, understanding consumer needs and use cases is the foundational step before modeling resources and defining endpoints, ensuring the resulting API architecture is consumer-centric and directly aligned with business objectives.

Related Skills

Explore More Software Engineering Skills→
h4vzzh4vzz
33

content-strategy

Generate a B2B content strategy with editorial calendars and measurement frameworks.

Community
Advanced
icartshicartsh
4

api-designer

Design RESTful and GraphQL APIs with OpenAPI 3.0 specifications.

Community
Advanced
saeed-vayghansaeed-vayghan
30

tooling-engineer

Design and implement CLI tools, build systems, and code generators.

Community
Advanced
majiayu000majiayu000
258

api-design

Design API contracts for REST, GraphQL, and gRPC contexts.

Community
Advanced