api-design

Standardizes REST API architecture including naming conventions, HTTP semantics, and error formats.

2|Updated Jun 14, 2026
One-click install
npx skills add https://github.com/eng-vmessiah/project-development-skill --skill api-design-eng-vmessiah
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/eng-vmessiah/project-development-skill/tree/main/skills/api-design
Command: npx skills add https://github.com/eng-vmessiah/project-development-skill --skill api-design-eng-vmessiah

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill eliminates inconsistency and architectural debt in API development by providing a standardized framework for resource naming, HTTP semantics, and error handling.

Core Features & Use Cases

  • Standardized Design: Enforces RESTful conventions for resource naming, versioning, and pagination.
  • Error & Rate Management: Implements RFC 7807 problem details and token-bucket rate limiting for production-grade reliability.
  • Use Case: Use this skill when architecting a new microservice to ensure your endpoints are predictable, secure, and easily consumable by frontend or third-party clients.

Quick Start

Use the api-design skill to generate an OpenAPI specification for a new product management service with standard CRUD endpoints.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a REST API with standard resource naming conventions and HTTP method semantics?

Design a REST API by enforcing standardized resource naming, mapping HTTP methods to correct operations, and structuring predictable endpoints. This approach eliminates architectural debt and ensures your backend service remains easily consumable by frontend or third-party clients.

What's the best way to implement RFC 7807 problem details for REST API error handling?

Implement RFC 7807 problem details to standardize REST API error response formats across your service. This provides production-grade reliability by delivering consistent, predictable error payloads to clients during API review and documentation phases.

How do I generate an OpenAPI specification for a new backend microservice?

Generate an OpenAPI specification by applying standardized REST architecture to your backend microservice design. This ensures your endpoints comply with industry standards for versioning, pagination, and overall API documentation during the development phase.

Does this REST API design approach support token-bucket rate limiting for production environments?

Yes, this REST API design approach supports token-bucket rate limiting to ensure production-grade reliability. It incorporates rate management and standard error handling to protect your backend service from excessive traffic and maintain predictable consumption.

When do I need to standardize API versioning and pagination strategies for my HTTP endpoints?

Standardize API versioning and pagination strategies when architecting a new microservice to ensure your HTTP endpoints are predictable and secure. This prevents architectural debt and maintains consistent consumption for frontend or third-party clients.