skills.rest
splits-network
splits-networkOFFICIAL
Explore all skills by this author →
WebsiteGitHub

api-specifications

Enforce V2 REST API standards with 5-route CRUD patterns using Fastify and Supabase.

1|Updated Dec 12, 2025
Search Tags:#documentation#api design#backend development#guidelines#rest api#v2 architecture#api specifications
One-click install
npx skills add https://github.com/splits-network/splits --skill api-specifications
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-specifications
Source: https://github.com/splits-network/splits/tree/main/.github/skills/api-specifications
Command: npx skills add https://github.com/splits-network/splits --skill api-specifications

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about api-specifications

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

FAQPage Schema
What is a standard 5-route CRUD pattern for REST API design?▼

A 5-route CRUD pattern for REST API design enforces consistent endpoints for creating, reading, updating, and deleting resources. This standardization ensures API predictability and maintainability across microservices.

How do I structure a uniform response envelope for REST APIs?▼

To structure a uniform response envelope for REST APIs, implement a standardized format that includes specific data payloads, pagination details, and consistent error structures across all V2 architecture endpoints.

How do I implement role-based access control in Fastify routing?▼

Implement role-based access control in Fastify routing by applying shared access context to filter requests. This ensures endpoints enforce specific permissions before processing repository and service layer operations.

Does this API specification guideline support Supabase for data access?▼

Yes, these API specification guidelines support Supabase for data access. They utilize specific patterns for repository and service layers that integrate seamlessly with Supabase and Fastify routing.

When should I publish domain events in a REST API implementation?▼

You should publish domain events in a REST API implementation immediately upon resource state changes. This pattern ensures downstream services are notified of updates while maintaining API consistency.

What are the documentation standards required for V2 API endpoints?▼

Documentation standards for V2 API endpoints require clear, comprehensive specifications for all 5-route CRUD operations. This includes detailing uniform response envelopes, role-based access rules, and domain event triggers.

Related Skills

Explore More Software Engineering Skills→
thesimonhothesimonho
26

backend-patterns

Automate backend architecture pattern application for API-driven and microservice designs.

Community
Advanced
The13thNodeThe13thNode
3

api-design

Designs REST and GraphQL API contracts with OpenAPI 3.0 specifications.

Community
Advanced
MolcajeteAIMolcajeteAI
2

authorization-patterns

Implement RBAC and ABAC authorization patterns with TypeScript and Fastify.

Official
Advanced
Corvalis-LLCCorvalis-LLC
6

auto-api-design

Standardize REST API design with response envelopes, status codes, and DTO separation.

Official
Advanced