bee:pre-dev-api-design
CommunityDefine API contracts before implementation.
Software Engineering#api design#api standards#bff#contract design#interface definition#protocol agnostic
Authorluanrodrigues
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill ensures that API contracts and component interfaces are clearly defined before any technology or protocol is selected, preventing integration failures and rework.
Core Features & Use Cases
- Standardized API Design: Enforces organizational naming standards and best practices for API fields, data types, and error codes.
- Protocol-Agnostic Contracts: Defines operations, inputs, outputs, and errors without specifying HTTP verbs, URLs, or serialization formats.
- BFF Contract Definition: For specific project topologies, designs optimized data contracts for Backend-for-Frontend (BFF) layers.
- Use Case: Before building a new microservice, use this Skill to document its public API, ensuring all other services know exactly what data and operations are available, and how to interact with them, without committing to a specific communication protocol yet.
Quick Start
Use the bee:pre-dev-api-design skill to define the API contract for the new user service, focusing on user creation and retrieval operations.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 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: bee:pre-dev-api-design Download link: https://github.com/luanrodrigues/ia-frmwrk/archive/main.zip#bee-pre-dev-api-design 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.