skills.rest
komluk
komlukCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design

Enforce RESTful API design standards for naming, HTTP methods, and status codes.

1|Updated Dec 14, 2025
Search Tags:#versioning#restful#api design#standards#api security#status codes#http methods
One-click install
npx skills add https://github.com/komluk/scaffolding.template --skill api-design-komluk
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/komluk/scaffolding.template/tree/main/stacks/_common/.claude/skills/api-design
Command: npx skills add https://github.com/komluk/scaffolding.template --skill api-design-komluk

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive set of standards and best practices to ensure the consistent, secure, and efficient design of RESTful APIs, reducing ambiguity and improving developer experience.

Core Features & Use Cases

  • Standardized Naming Conventions: Enforces clear and consistent resource naming (nouns, plural, kebab-case).
  • HTTP Method Guidance: Details the appropriate use of GET, POST, PUT, PATCH, and DELETE for CRUD operations and actions.
  • Status Code Best Practices: Defines correct usage of 2xx, 4xx, and 5xx status codes for clear communication.
  • Response & Error Formatting: Establishes structured success and error response formats, including pagination standards.
  • Security & Versioning: Outlines security requirements (authentication, authorization, rate limiting) and versioning strategies.
  • Use Case: When designing a new /products endpoint, use this Skill to ensure the URL is plural, uses kebab-case, and that the appropriate HTTP methods (e.g., POST for creation, GET for retrieval) are used with correct status codes and response structures.

Quick Start

Use the api-design skill to create a new RESTful API endpoint for managing user profiles, ensuring adherence to all naming and HTTP method standards.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design RESTful API URL structures for nested resources and actions?▼

Design RESTful API URL structures by using plural nouns, kebab-case formatting, and clear hierarchies for collection, item, nested, and action URLs. This ensures consistent resource naming, reduces ambiguity, and improves the overall developer experience for your endpoints.

What HTTP methods and status codes should I use for RESTful API CRUD operations?▼

Use HTTP methods GET, POST, PUT, PATCH, and DELETE for RESTful API CRUD operations, returning appropriate 2xx, 4xx, and 5xx status codes. Mapping methods to operations and using correct status codes ensures clear communication and structured success or error response formatting.

How should I format RESTful API error responses and pagination?▼

Format RESTful API error responses and pagination using established structured standards for success and error outputs. Defining consistent response structures, including pagination standards, enables maintainable APIs and clear communication of failure states to API consumers.

What are the best practices for RESTful API versioning and security?▼

RESTful API versioning and security best practices involve implementing authentication, authorization, rate limiting, and clear versioning strategies. Adopting these standards protects endpoints and facilitates the creation of well-documented, secure, and maintainable APIs.

When should I use PATCH instead of PUT for RESTful API updates?▼

Use PATCH instead of PUT for RESTful API updates when performing partial modifications to a resource. Following standard HTTP method semantics ensures correct CRUD operation mapping, preventing full overwrites when only specific fields require updating.

Does this RESTful API design skill work without external dependencies?▼

Yes, this RESTful API design skill works without external dependencies, providing a comprehensive set of standards and best practices directly. It enforces resource naming, HTTP method usage, status codes, and response structures to ensure consistent and efficient API creation.

Related Skills

Explore More Software Engineering Skills→
GenuinehGenuineh

backend-api

Guide backend RESTful API design covering naming, HTTP methods, status codes, and versioning.

Community
Intermediate
patricio0312revpatricio0312rev
5

api-docs-generator

Generate OpenAPI documentation and multi-language SDKs from YAML or JSON specifications.

Community
Advanced
weirdgmeweirdgme
4

api-engineering

Automate API design and governance with REST, GraphQL, and gRPC best practices.

Community
Advanced
timequitytimequity
6

graphql-api

Design GraphQL schemas, implement resolvers, and enable subscriptions.

Official
Advanced