skills.rest
jamestorrevillas
jamestorrevillasCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design and review REST, GraphQL, tRPC, or gRPC APIs with structured best practices.

3|4|Updated Mar 20, 2026
Search Tags:#versioning#security#rest#graphql#pagination#grpc#api-design
One-click install
npx skills add https://github.com/jamestorrevillas/dev-skills --skill api-design-jamestorrevillas
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/jamestorrevillas/dev-skills/tree/main/.github/skills/api-design
Command: npx skills add https://github.com/jamestorrevillas/dev-skills --skill api-design-jamestorrevillas

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

API design and contract uncertainty slows delivery and causes integration pain; inconsistent interfaces create maintenance toil across teams.

Core Features & Use Cases

  • Guided API type selection (REST, GraphQL, tRPC, or gRPC) based on client needs.
  • Versioning, deprecation, and backward-compatibility strategies for stable APIs.
  • Schema design best practices, pagination, security considerations, and performance tips.

Quick Start

Design a robust API contract for a new service using REST, GraphQL, or gRPC patterns.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I choose between REST, GraphQL, tRPC, and gRPC for my new service?▼

API type selection is guided by your specific client needs and service constraints. This framework helps you evaluate REST, GraphQL, tRPC, and gRPC to determine the most suitable protocol for your architecture and scaling demands.

What is the best way to handle API versioning and deprecation?▼

API versioning and deprecation require structured strategies for backward compatibility. You can apply established versioning patterns to maintain stable APIs during iteration while safely phasing out outdated endpoints without breaking clients.

How do I design pagination and schema for scalable APIs?▼

API pagination and schema design follow specific best practices for performance and scalability. You can implement standardized pagination techniques and schema structures to ensure efficient data retrieval and consistent interfaces across services.

Does this framework enforce security considerations for API contracts?▼

API security considerations are enforced within the design framework. You receive structured guidance to incorporate security standards directly into your API contracts, ensuring robust protection across REST, GraphQL, and gRPC implementations.

When do I need a structured framework for API design?▼

A structured API design framework is needed when contract uncertainty slows delivery and causes integration pain. It resolves inconsistent interfaces across teams, reducing maintenance toil by enforcing documentation and schema standards.

Related Skills

Explore More Software Engineering Skills→
leaderiopleaderiop
7

Advanced Modular Library Design

Define package boundaries and API contracts for modular libraries.

Community
Advanced
hffmnnjhffmnnj
39

api-docs

Generate API reference documentation from OpenAPI specs and GraphQL schemas.

Community
Advanced
AcczdyAcczdy
2

implementing-api-abuse-detection-with-rate-limiting

Implement API abuse detection with token bucket, sliding window, and adaptive rate limiting on Redis.

Community
Advanced
copilot-ldcopilot-ld
1

libcodegen

Generate JavaScript message classes, service stubs, and type definitions from .proto files.

Official
Advanced