skills.rest
enoch-robinson
enoch-robinsonCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design consistent RESTful APIs with resource-oriented routing and versioning.

Updated Jan 10, 2026
Search Tags:#design#versioning#documentation#consistency#API#REST#endpoints
One-click install
npx skills add https://github.com/enoch-robinson/agent-skill-collection --skill api-design-enoch-robinson
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/enoch-robinson/agent-skill-collection/tree/main/skills/development/api-design
Command: npx skills add https://github.com/enoch-robinson/agent-skill-collection --skill api-design-enoch-robinson

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides comprehensive RESTful API design guidance to ensure interfaces are consistent, usable, and evolvable when designing new APIs, documenting endpoints, or evaluating existing designs.

Core Features & Use Cases

  • Resource-first design: URLs represent resources and HTTP methods express actions.
  • Consistency and versioning: Enforces naming conventions, response formats, and versioning strategies.
  • Documentation guidance: Offers guidelines for API docs, schemas, error formats, and example payloads.
  • Use Case: When building a new service, auditing an existing API, or evaluating a third-party API design.

Quick Start

Propose a RESTful API structure for a new service, including endpoints for primary resources, HTTP methods, and sample request/response payloads.

Frequently Asked Questions about api-design

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

FAQPage Schema
What is the best way to design consistent REST API endpoints?▼

The best way to design consistent REST API endpoints is to enforce resource-oriented routing, standard HTTP methods, and uniform naming conventions across all services. This approach ensures your API structure remains predictable and evolvable as platforms scale.

How do I structure a RESTful API for a new service?▼

To structure a RESTful API for a new service, define primary resources as URLs and use HTTP methods to express actions. You should specify endpoint schemas, versioning strategies, structured error formats, and example request and response payloads.

How does API versioning work when updating existing endpoints?▼

API versioning works by enforcing specific versioning strategies within the endpoint specification to maintain backward compatibility. It allows developers to iterate on response formats and routing structures without breaking existing client integrations.

What should be included in REST API documentation?▼

REST API documentation should include resource-oriented routing guidelines, endpoint schemas, structured error formats, and example request and response payloads. Comprehensive documentation ensures interfaces are usable and easy to evaluate across services.

Can I use this approach to audit an existing API design?▼

Yes, you can use resource-oriented design principles to audit an existing API or evaluate a third-party API. Checking for consistent naming, versioning, and structured error formats helps identify usability and evolvability gaps in current endpoints.

Related Skills

Explore More Software Engineering Skills→
nextplus896nextplus896

laravel-controllers

Enforce thin Laravel controllers that delegate business logic to actions.

Community
Basic
686f6c61686f6c61
105

api-docs

Generate API documentation with HTTP methods, routes, parameters, and schemas.

Community
Intermediate
alirezarezvanialirezarezvani
763

api-documenter

Generate OpenAPI 3.0 specifications from code across multiple frameworks.

Community
Basic
sawrussawrus
17

api-design-principles

Design REST and GraphQL APIs with schema-first patterns and versioning.

Community
Basic