skills.rest
ensi-platform
ensi-platformOFFICIAL
Explore all skills by this author →
WebsiteGitHub

ensi-api-design

Validate Ensi API endpoints against the Ensi API Design Guide.

1|2|Updated Mar 25, 2026
Search Tags:#api design#openapi#rest api#api documentation#ensi
One-click install
npx skills add https://github.com/ensi-platform/skills --skill ensi-api-design
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: ensi-api-design
Source: https://github.com/ensi-platform/skills/tree/main/skills/ensi-api-design
Command: npx skills add https://github.com/ensi-platform/skills --skill ensi-api-design

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

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.

Frequently Asked Questions about ensi-api-design

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

FAQPage Schema
How do I ensure my REST API structure adheres to the Ensi API Design Guide?▼

To ensure REST API design adherence, validate URL paths for proper pluralization, kebab-case formatting, and versioning. The Ensi API Design Guide principles standardize endpoint structures to maintain consistency across services.

What HTTP status codes and response formats should REST API endpoints use?▼

REST API responses should use standardized structures containing data, errors, and meta fields. Specific HTTP status codes are recommended for different scenarios to ensure consistent API communication and error handling.

Do I need an OpenAPI 3.0 specification for API documentation in Ensi projects?▼

Yes, OpenAPI 3.0 specification is required for API documentation in Ensi projects. Accessible documentation must be provided to ensure endpoints are well-structured and easy to use.

What field formats are required when designing REST APIs for Ensi services?▼

REST API field formats require integer IDs, ISO-8601 datetime fields, and kopeck prices. Consistent naming conventions and JSON data transfer are enforced to maintain data integrity.

How does API versioning work for breaking changes in REST API design?▼

API versioning for breaking changes involves specific versioning rules in the URL structure. The strategy outlines how to handle modifications while maintaining backward compatibility for existing API consumers.

Related Skills

Explore More Software Engineering Skills→
xloxn69xloxn69
7

api-documentation-generator

Generate OpenAPI 3.0 YAML/JSON specifications for REST API endpoints.

Community
Basic
gridi-aigridi-ai
1

be-spec

Generate OpenAPI 3.0 specifications from tech specs for REST APIs.

Official
Advanced
GaryOcean428GaryOcean428

api-design-validation

Validate REST API endpoint naming, HTTP methods, and status codes.

Community
Intermediate
zagarlucaszagarlucas

openapi-spec-writer

Generate OpenAPI 3.0/3.1 specifications for REST APIs with reusable components.

Community
Advanced