skills.rest
masermediagroup-stack
masermediagroup-stackCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

designing-sdks

Design production-ready SDKs for REST APIs with retry, pagination, and error handling.

1|Updated Apr 8, 2026
Search Tags:#design#architecture#sdk#error-handling#pagination#retry
One-click install
npx skills add https://github.com/masermediagroup-stack/CursorSkills --skill designing-sdks-masermediagroup-stack
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: designing-sdks
Source: https://github.com/masermediagroup-stack/CursorSkills/tree/main/skills-bundle/skills/community/ai-design-components/skills/designing-sdks
Command: npx skills add https://github.com/masermediagroup-stack/CursorSkills --skill designing-sdks-masermediagroup-stack

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Solves the problem of designing production-ready SDKs and developer-friendly client libraries by providing a structured approach to architecture, error handling, retries, pagination, and cross-language patterns.

Core Features & Use Cases

  • Architecture patterns: resource-based vs command-based for scalable API surfaces.
  • Robust error handling: typed errors, clear diagnostics, and retry strategies.
  • Pagination and streaming: support for async iterators and cursor-based pagination across languages.
  • Authentication and versioning: strong patterns for API keys, token refresh, and semantic versioning.
  • Real-world use case: craft Stripe/OpenAI-like SDKs in TypeScript, Python, and Go to illustrate DX best practices.

Quick Start

Define a high-level SDK design for a REST API, then draft language-specific patterns and documentation templates.

Frequently Asked Questions about designing-sdks

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

FAQPage Schema
How do I design an SDK with robust error handling and retry logic?▼

To design an SDK with robust error handling, implement typed errors, clear diagnostics, and structured retry strategies. This approach ensures production-ready client libraries by prescribing architecture patterns and language-specific error management techniques.

What's the best way to structure pagination in a multi-language API SDK?▼

The best way to structure pagination in a multi-language API SDK is using cursor-based pagination alongside async iterators. This pattern supports streaming data efficiently across languages like TypeScript, Python, and Go while maintaining consistent developer experience.

When should I choose resource-based versus command-based architecture for a client library?▼

Choose resource-based architecture for client libraries when mapping scalable REST API surfaces directly to endpoints, whereas command-based architecture suits action-oriented APIs. Selecting the correct architecture pattern ensures a developer-friendly surface for your API integration.

Does this approach support building SDKs across TypeScript, Python, and Go?▼

Yes, this approach supports building SDKs across TypeScript, Python, and Go by providing cross-language patterns for authentication, token refresh, and semantic versioning. It illustrates developer experience best practices using Stripe or OpenAI-like SDK examples.

How do I implement versioning and authentication patterns for production-ready SDKs?▼

Implement versioning and authentication patterns for production-ready SDKs by applying strong semantic versioning rules alongside structured API key and token refresh management. These patterns maintain backward compatibility and secure access across multi-language client libraries.

Related Skills

Explore More Software Engineering Skills→
mpadmarajmpadmaraj
2

api-design

Define REST API contracts with endpoints, HTTP methods, schemas, and error handling.

Community
Basic
GP-CRM-SystemGP-CRM-System

openapi-spec-generation

Generate and validate OpenAPI 3.1 specifications from code and design inputs.

Official
Advanced
h4vzzh4vzz
33

api-integration

Generate production-grade API clients with authentication, retry logic, and error handling.

Community
Advanced
buisihung11buisihung11

nx-generate

Generate applications and libraries using Nx generators in a monorepo.

Community
Intermediate