skills.rest
rbarcante
rbarcanteCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Define and enforce RESTful API design guidelines for endpoints, routes, and controllers.

54|1|Updated Jan 23, 2026
Search Tags:#design#versioning#api#rest#error-handling#endpoints#back-end
One-click install
npx skills add https://github.com/rbarcante/claude-conductor --skill api-design-rbarcante
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/rbarcante/claude-conductor/tree/main/skills/api-design
Command: npx skills add https://github.com/rbarcante/claude-conductor --skill api-design-rbarcante

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The API Design Skill provides guidance for designing and implementing RESTful APIs, including REST conventions, error handling, and versioning, to help teams create consistent and scalable interfaces.

Core Features & Use Cases

  • Guidance on REST conventions (URL naming, HTTP methods, resource design)
  • Standardized error responses and versioning patterns
  • Activation patterns and recommended tooling for API projects
  • Use case: when starting a new API project, apply consistent patterns to avoid design drift and simplify onboarding.
  • Use Case: refactor existing endpoints to align with REST best practices and versioned endpoints.

Quick Start

Create a new API module following the REST conventions, error handling, and versioning guidelines described in this skill.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design REST API endpoints for a new back-end project?▼

Design REST API endpoints by applying standardized guidelines for URL naming, HTTP methods, and resource design. This skill enforces REST conventions directly within routes and controllers to ensure consistent, scalable interfaces from project start.

What are the best REST API conventions for error handling and versioning?▼

REST API conventions for error handling and versioning involve standardizing error response structures and applying consistent versioning patterns. This skill provides specific guidance to prevent design drift and simplify team onboarding.

Does this API design guidance work with Express, FastAPI, and NestJS?▼

Yes, this API design guidance works with Express, FastAPI, and NestJS. It activates automatically for back-end stacks with files located under routes/, controllers/, api/, or endpoints/ directories.

How do I refactor existing API endpoints to align with REST best practices?▼

Refactor existing API endpoints by applying consistent REST patterns, error handling, and versioning guidelines. This skill helps align current routes and controllers with established REST best practices to improve interface consistency.

Why does my REST API suffer from design drift across different endpoints?▼

REST API design drift occurs when endpoints lack standardized conventions for resource design and error responses. Applying consistent REST guidelines helps teams avoid this issue and simplifies developer onboarding.

Related Skills

Explore More Software Engineering Skills→
oaustegardoaustegard
137

versioning-skills

Initialize Git repositories and commit changes for skill directories.

Community
Basic
hffmnnjhffmnnj
39

api-docs

Generate API reference documentation from OpenAPI specs and GraphQL schemas.

Community
Advanced
abdullah1854abdullah1854
1

api-test-gen

Generate Jest/Supertest or Pytest test templates for REST endpoints.

Community
Advanced
davidrrowleydavidrrowley

api-design

Design and validate REST, GraphQL, and gRPC API contracts with OpenAPI schemas.

Community
Advanced