skills.rest
Tibsfox
TibsfoxCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design

Design and validate REST API endpoints, methods, and status codes.

69|9|Updated Jan 30, 2026
Search Tags:#design#api#rest#http#best-practices#endpoints
One-click install
npx skills add https://github.com/Tibsfox/gsd-skill-creator --skill api-design-tibsfox
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Tibsfox/gsd-skill-creator/tree/main/examples/skills/api-design
Command: npx skills add https://github.com/Tibsfox/gsd-skill-creator --skill api-design-tibsfox

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps teams design consistent, secure REST APIs by providing conventions, patterns, and examples to reduce ambiguity and rework across services.

Core Features & Use Cases

  • Endpoint naming conventions that favor nouns, plurals, and kebab-case for readability and consistency.
  • HTTP method semantics guidance, mapping operations to GET, POST, PUT, PATCH, and DELETE.
  • Status code guidance with examples for common success and error responses, plus recommended practices for error handling.
  • Use Case: design a new /customers API with clear routes, methods, and responses following the conventions.

Quick Start

Provide a minimal REST API design for a simple resource to demonstrate naming, method choices, and status codes.

Frequently Asked Questions about api-design

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

FAQPage Schema
What are the best practices for REST API endpoint naming conventions?▼

REST API endpoint naming best practices favor using nouns, plurals, and kebab-case to improve readability and consistency. This approach reduces ambiguity and minimizes rework across services and microservices.

How do I choose the right HTTP methods for my REST API design?▼

Choose HTTP methods for REST API design by mapping operations to their correct semantics: GET for retrieval, POST for creation, PUT and PATCH for updates, and DELETE for removal, enforcing standard conventions.

What HTTP status codes should I use for REST API success and error responses?▼

Use HTTP status codes for REST API responses by applying standard guidance for common success and error scenarios. This includes recommended practices for structured error handling to ensure clear client communication.

How do I design a REST API structure for microservices?▼

Design REST API structures for microservices by applying standard conventions and patterns to endpoints, methods, and status codes. This ensures consistent and secure communication across distributed services.

Does this REST API design guidance support learning through examples?▼

Yes, this REST API design guidance supports learning through examples. It provides a reference for endpoint naming, method semantics, and status code usage to help teams validate structures and reduce ambiguity.

Related Skills

Explore More Software Engineering Skills→
codeworksIDcodeworksID
17

backend-api-design

Design REST, GraphQL, and gRPC APIs with OpenAPI/Swagger specification generation.

Community
Advanced
feasibleonefeasibleone
1

blong-rest

Implement REST APIs from OpenAPI specs within Blong's gateway.

Official
Intermediate
GaryOcean428GaryOcean428

api-design-validation

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

Community
Intermediate
erichowenserichowens
181

api-architect

Design and validate REST, GraphQL, and gRPC API contracts and architectures.

Community
Advanced