apis

Design consistent REST, GraphQL, tRPC, webhook, and SDK APIs for SaaS products.

1|Updated Apr 3, 2026
One-click install
npx skills add https://github.com/lucaspedrozaem/saasskills --skill apis
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: apis
Source: https://github.com/lucaspedrozaem/saasskills/tree/main/skills/apis
Command: npx skills add https://github.com/lucaspedrozaem/saasskills --skill apis

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams design consistent, discoverable, and backward-compatible APIs for SaaS products, reducing integration friction, preventing breaking changes, and improving developer experience across internal and external consumers.

Core Features & Use Cases

  • API style guidance: Recommend REST, GraphQL, tRPC, or gRPC based on consumer needs and trade-offs.
  • Design rules and patterns: URL structure, HTTP methods, idempotency, pagination strategies, filtering, and sparse fieldsets.
  • Reliability & security: Authentication models, API key conventions, rate limiting, error formats, and webhook best practices.
  • Documentation & SDKs: OpenAPI-first approach, quickstart examples, changelogs, and SDK generation for multiple languages.
  • Use Case: Create a public REST API with versioning, OpenAPI docs, rate limits, and webhook event delivery for a multi-tenant project management SaaS.

Quick Start

Design a v1 REST API for a project management SaaS with resources users, teams, and projects, include cursor pagination, OpenAPI documentation, and API key authentication.

Frequently Asked Questions about apis

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

FAQPage Schema
How do I design a REST API with pagination and API key authentication?

To design a REST API with pagination and API key authentication, define consistent URL structures, implement cursor pagination for large datasets, and apply standard security controls to validate API keys, ensuring scalable and developer-friendly consumption.

What is the best way to structure webhook event delivery for a multi-tenant SaaS?

The best way to structure webhook event delivery for a multi-tenant SaaS is to apply webhook best practices including reliable payload formats, clear event documentation, and robust security controls like signed payloads and rate limiting to ensure consistent event delivery.

Should I choose REST, GraphQL, or tRPC for my SaaS product API?

Choosing between REST, GraphQL, and tRPC depends on your consumer needs and trade-offs. REST offers broad compatibility and OpenAPI support, GraphQL provides flexible data fetching, and tRPC enables end-to-end type safety for internal services.

How do I generate OpenAPI specifications and prevent breaking changes in API versioning?

To generate OpenAPI specifications and prevent breaking changes, adopt an OpenAPI-first approach to document endpoints, implement strict API versioning in the URL structure, and maintain detailed changelogs to ensure backward compatibility across API versions.

What should be included in SaaS API error handling and rate limiting strategies?

SaaS API error handling and rate limiting strategies should include consistent error response envelopes, standard HTTP status codes, clear API key authentication conventions, and explicit rate limiting thresholds to protect services and guide consumer integration.