skills.rest
Xyxy1722
Xyxy1722COMMUNITY
Explore all skills by this author →
GitHub

api-design

Define RESTful API conventions for resource naming, status codes, and error responses.

Updated Jan 20, 2026
Search Tags:#documentation#api design#rest#backend development#web services#api patterns
One-click install
npx skills add https://github.com/Xyxy1722/Agent-skills --skill api-design-xyxy1722
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Xyxy1722/Agent-skills/tree/main/develop/api-design
Command: npx skills add https://github.com/Xyxy1722/Agent-skills --skill api-design-xyxy1722

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive guide to designing robust, scalable, and developer-friendly REST APIs, addressing common pitfalls and promoting best practices.

Core Features & Use Cases

  • Resource Naming & URL Structure: Establishes conventions for clear and consistent API endpoints.
  • HTTP Methods & Status Codes: Details the semantic use of HTTP verbs and status codes for predictable interactions.
  • Pagination, Filtering, Sorting: Offers strategies for efficient data retrieval and manipulation.
  • Error Handling & Versioning: Guides on creating informative error responses and managing API evolution.
  • Use Case: When starting a new microservice that will expose data to other internal teams or external partners, use this Skill to ensure the API is well-designed from the outset.

Quick Start

Use the api-design skill to define the structure for a new /users endpoint, including resource naming 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 resource naming and URL structure?▼

REST API resource naming best practices involve establishing conventions for clear and consistent API endpoints. This ensures your URL structure uses standard semantics for predictable interactions across resource collections.

How do I design pagination, filtering, and sorting for REST APIs?▼

Designing pagination, filtering, and sorting for REST APIs requires strategies for efficient data retrieval. Implementing these mechanisms allows clients to manipulate large datasets without overwhelming backend web services.

What HTTP status codes and methods should I use for REST API design?▼

REST API design should use HTTP methods and status codes with correct semantic meaning. Detailed use of HTTP verbs and status codes ensures predictable interactions and accurate response formats for production environments.

How do I handle error responses and API versioning in backend development?▼

Handling error responses and API versioning in backend development involves creating informative error messages and managing API evolution. This approach guides developers on failures while maintaining backward compatibility.

Does this API design guidance apply to production microservices for external partners?▼

Yes, this API design guidance applies to production microservices for external partners. It addresses common API design challenges for production environments, ensuring web services are robust and developer-friendly.

Related Skills

Explore More Software Engineering Skills→
PrimadetaautomationPrimadetaautomation
5

backend-development-patterns

Provide standardized backend development patterns for REST and GraphQL APIs, databases, and microservices.

Community
Advanced
ehtbantonehtbanton

openapi-spec-builder

Generate OpenAPI 3.x specification files in YAML or JSON format.

Community
Intermediate
dpieterszdpietersz

Backend API

Design RESTful API endpoints, controllers, and middleware for scalable web services.

Community
Intermediate
iludeilude
8

api-design-patterns

Design REST and GraphQL APIs with language-agnostic patterns for routes, schemas, and specs.

Community
Advanced