api-design-patterns

Design REST APIs with versioning, response envelopes, and OpenAPI conventions.

27|9|Updated Jan 20, 2026
One-click install
npx skills add https://github.com/sabahattink/antigravity-fullstack-hq --skill api-design-patterns-sabahattink
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-patterns
Source: https://github.com/sabahattink/antigravity-fullstack-hq/tree/main/skills/api-design-patterns
Command: npx skills add https://github.com/sabahattink/antigravity-fullstack-hq --skill api-design-patterns-sabahattink

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Designing REST APIs that are versioned, well-documented, and robust against errors is error-prone and time-consuming without a consistent pattern.

Core Features & Use Cases

  • Standardized response envelopes with explicit error codes to improve client reliability.
  • Versioned routing, pagination, and HTTP status mappings to support scalable APIs.
  • OpenAPI/Swagger setup and documentation patterns for NestJS or Express ecosystems.

Quick Start

Integrate these patterns into your NestJS or Express API project to standardize endpoints, responses, and docs.

Frequently Asked Questions about api-design-patterns

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

FAQPage Schema
How do I design a REST API with consistent versioning and error handling?

You can standardize REST API design by enforcing a standard response envelope, explicit error codes, and versioned routes, which improves client reliability and supports scalable public or internal services.

What is the best way to structure pagination in a REST API?

Structuring REST API pagination requires applying clear pagination patterns alongside standardized response envelopes and explicit HTTP status mappings to ensure clients can reliably retrieve large datasets.

How do I set up OpenAPI documentation for a NestJS or Express API?

Setting up OpenAPI documentation for NestJS or Express APIs involves applying specific documentation patterns and OpenAPI conventions to standardize endpoint design and maintain robust API references.

Does this REST API design approach work for internal services as well as public APIs?

Yes, this REST API design approach applies to both public and internal services, providing backend engineers with consistent endpoint design, response envelopes, and error handling across frameworks like NestJS or Express.

Why do I need a standardized response envelope in my REST API?

You need a standardized response envelope in your REST API to improve client reliability by ensuring consistent data structures and explicit error codes across all endpoints, reducing integration errors and parsing complexity.