ensi-api-design
OfficialEnsure API consistency and adherence to Ensi API Design Guide principles.
Authorensi-platform
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill helps maintain consistency and adherence to the Ensi API Design Guide principles, ensuring that API endpoints in Ensi projects are well-structured, easy to use, and follow best practices.
Core Features & Use Cases
- API Design Principles: Enforces REST architectural style, JSON data transfer, and consistent naming conventions.
- URL Structure: Ensures proper pluralization, kebab-case, and versioning in URL paths.
- Field Formats: Validates integer IDs, ISO-8601 datetime fields, and kopeck prices.
- Response Format: Standardizes response structure with data, errors, and meta fields.
- API Architecture: Provides guidelines for Back Services and Gateway Services architecture.
- HTTP Status Codes: Recommends specific status codes for different scenarios.
- API Versioning: Outlines breaking changes strategy and versioning rules.
- API Documentation: Requires OpenAPI 3.0 specification and accessible documentation.
- Use Case: When designing or reviewing REST API endpoints in Ensi services, this Skill ensures adherence to the Ensi API Design Guide.
Quick Start
Apply the ensi-api-design skill to design a new API endpoint following the Ensi API Design Guide principles.
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 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: ensi-api-design Download link: https://github.com/ensi-platform/skills/archive/main.zip#ensi-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 620,000+ vetted skills library on demand.