api-specifications

What problem does it solve?

This Skill ensures consistency, quality, and maintainability in the development of REST APIs across the Splits Network platform.

Core Features & Use Cases

• Standardized API Architecture: Enforces a consistent 5-route CRUD pattern for all V2 resources.
• Uniform Response Format: Mandates a specific envelope for all API responses, including pagination and error structures.
• Access Control Integration: Guides the implementation of role-based filtering using shared access context.
• Event Publishing: Provides patterns for emitting domain events upon resource state changes.
• Documentation Standards: Outlines requirements for documenting API endpoints clearly and comprehensively.
• Use Case: When building a new microservice, use this Skill to ensure all its API endpoints adhere to the V2 standards, making them predictable and easier for other services and frontends to consume.

Quick Start

Follow the V2 API Architecture Standards to implement a new resource endpoint.