skills.rest
rlagycks
rlagycksCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Define REST API resource naming, HTTP methods, status codes, pagination, filtering, versioning, and error responses.

3|Updated Apr 9, 2026
Search Tags:#design#best practices#documentation#web development#api#rest
One-click install
npx skills add https://github.com/rlagycks/oh-my-forge --skill api-design-rlagycks
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/rlagycks/oh-my-forge/tree/main/.agents/skills/api-design
Command: npx skills add https://github.com/rlagycks/oh-my-forge --skill api-design-rlagycks

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidelines and conventions for creating consistent and developer-friendly REST APIs.

Core Features & Use Cases

  • API Structuring: Defines resource URL patterns, HTTP methods, and status codes for robust API design.
  • Error Handling: Guides on semantic status codes and proper error response formats.
  • Best Practices: Covers pagination, filtering, versioning, and security considerations for API development.
  • Use Case: Use this Skill when designing new API endpoints or reviewing existing API contracts to ensure they adhere to industry standards.

Quick Start

Use the api-design skill to establish a standardized API structure for your web service.

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 structuring?▼

REST API resource naming best practices involve defining clear resource URL patterns and applying standard HTTP methods to ensure robust, consistent API design. This establishes a standardized structure for web service endpoints.

How do I handle error responses and HTTP status codes in a REST API?▼

To handle REST API errors, use semantic HTTP status codes and structured error response formats. Proper error handling ensures reliable integration and clear communication of API failures to developers.

What is the best way to implement pagination and filtering in web APIs?▼

The best way to implement pagination and filtering in web APIs is to follow established API design best practices. These conventions manage large datasets efficiently, ensuring clarity and scalability in your software development projects.

How do I version REST API endpoints for long-term scalability?▼

REST API versioning is achieved by applying specific best practices for endpoint management and documentation. Proper versioning strategies ensure consistency and reliable integration as your web service evolves.

Can I use these API design guidelines to review existing API contracts?▼

Yes, you can use these REST API design guidelines to review existing API contracts. They help ensure your current web service endpoints adhere to industry standards for resource naming, security, and error handling.

Related Skills

Explore More Software Engineering Skills→
xiaoweidotnetxiaoweidotnet
22

spec-driven-development

Generate structured technical specification documents defining project scope, architecture, and success criteria.

Community
Intermediate
oimiragieooimiragieo
36

doc-generator

Generate API documentation, developer guides, and OpenAPI/Swagger specs from code.

Community
Advanced
alexsandrocruzalexsandrocruz

api-design-principles

Design REST APIs with resource-oriented naming, HTTP methods, status codes, and versioning.

Community
Basic
yusufcmgyusufcmg
1

api-design-principles

Guide REST and GraphQL API design with patterns and best practices.

Community
Intermediate