api-designer

Design RESTful and gRPC APIs with endpoint conventions and error formats.

Updated Jan 29, 2026
One-click install
npx skills add https://github.com/semirm-dev/agent-army --skill api-designer-semirm-dev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/semirm-dev/agent-army/tree/main/claude/skills/api-designer
Command: npx skills add https://github.com/semirm-dev/agent-army --skill api-designer-semirm-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides guidance and scaffolding for designing RESTful and gRPC APIs, ensuring consistency, adherence to best practices, and efficient error handling.

Core Features & Use Cases

  • API Design Standards: Enforces naming conventions, HTTP method usage, and status code correctness.
  • Error Response Scaffolding: Provides a standardized JSON error format for consistent error reporting.
  • Pagination Helpers: Offers patterns for both cursor-based and offset-based pagination.
  • GraphQL Best Practices: Includes guidelines for schema design, DataLoader, and error handling in GraphQL.
  • Rate Limiting Strategies: Details how to implement effective rate limiting for various endpoint types.

Quick Start

Use the api-designer skill to help design a new REST API endpoint for user management.

Frequently Asked Questions about api-designer

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

FAQPage Schema
What is the best way to design a REST API with consistent error handling and pagination?

Designing a REST API with consistent error handling involves using a standardized JSON error format and implementing pagination strategies like cursor-based or offset-based patterns for efficient data retrieval.

How do I implement rate limiting strategies for different API endpoint types?

Implementing rate limiting requires detailing specific strategies tailored to various endpoint types, ensuring your API design maintains service availability and prevents abuse under heavy request loads.

How does GraphQL schema design use the DataLoader pattern for efficient data retrieval?

GraphQL schema design uses the DataLoader pattern to batch and cache data fetching requests, preventing inefficient N+1 query problems and optimizing complex data retrieval operations in your API.

Can I use this API design guidance for both RESTful and gRPC endpoint conventions?

Yes, this API design guidance provides comprehensive scaffolding for both RESTful and gRPC APIs, covering endpoint conventions, HTTP method usage, and status code correctness across different scenarios from basic CRUD to complex data retrieval.

When should I use cursor-based pagination instead of offset-based pagination in API design?

Use cursor-based pagination instead of offset-based pagination when designing APIs that handle large or frequently updated datasets, as cursors provide more stable retrieval without skipping records during insertions.