api-envelope-pattern
OfficialUniform API responses with a single envelope.
Authorplanetaryescape
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill enforces a consistent API envelope across all responses, ensuring every success, list, and error output includes structured data, metadata, and compact payloads.
Core Features & Use Cases
- Standard Envelope: Wraps responses with a uniform ApiResponse structure, including sys metadata and a compact data payload.
- Helpers & Consistency: Relies on formatEntity, formatEntityList, and formatErrorEntity to format data before returning from the DAL and route handlers.
- Use Case: When building web or mobile APIs, adopt the envelope pattern to enable predictable client parsing, easier caching, and robust error handling.
Quick Start
Integrate the envelope helpers into a route: wrap data with formatEntity/formatEntityList and return the result via NextResponse.json.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: api-envelope-pattern Download link: https://github.com/planetaryescape/blah.chat/archive/main.zip#api-envelope-pattern Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.