api-design

Design REST, GraphQL and gRPC APIs with authentication and pagination templates.

10|2|Updated Mar 12, 2026
One-click install
npx skills add https://github.com/viktorbezdek/skillstack --skill api-design-viktorbezdek
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/viktorbezdek/skillstack/tree/main/api-design/skills/api-design
Command: npx skills add https://github.com/viktorbezdek/skillstack --skill api-design-viktorbezdek

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

Designing consistent, secure, and versioned APIs across multiple protocols is time‑consuming and error‑prone, especially when handling schemas, authentication, pagination, and error contracts.

Core Features & Use Cases

  • Unified API Blueprint: Templates for REST, GraphQL, and gRPC with OpenAPI/Swagger specs and Pydantic models.
  • Security & Versioning: Built‑in JWT, API‑Key patterns, and semantic versioning guidelines.
  • Production‑Ready Patterns: Pagination (cursor and offset), rate‑limiting headers, and standardized error response formats.

Quick Start

Ask the assistant to generate a complete FastAPI CRUD endpoint for a “User” resource with OpenAPI spec.

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 with OpenAPI specs and Pydantic models in FastAPI?

You can design a REST API in FastAPI by generating complete CRUD endpoints with integrated OpenAPI/Swagger specs and Pydantic models. This provides a unified API blueprint with standardized schemas, security patterns, and production-ready error handling templates.

What's the best way to handle API authentication and versioning across microservices?

The best way to handle API authentication and versioning is using built-in JWT and API-Key patterns alongside semantic versioning guidelines. These templates ensure consistent, secure access control and contract management across microservice architectures.

How do I implement cursor and offset pagination with rate-limiting in an API?

Implement cursor and offset pagination with rate-limiting by applying built-in production-ready patterns. This includes standardized pagination templates and rate-limiting headers that ensure consistent data fetching behavior and protect backend resources.

Can I use this to generate GraphQL schemas and error handling templates for new services?

Yes, you can generate GraphQL schemas and standardized error response formats for new services. It provides unified templates across multiple protocols, ensuring consistent API contracts, secure authentication, and robust error handling documentation.

Do I need pyyaml installed to generate OpenAPI and Swagger spec templates?

Yes, pyyaml is required as a dependency to generate and process OpenAPI and Swagger spec templates. This library handles YAML parsing for the configuration files and schema definitions used throughout the API design process.