rest-api-design

Design REST APIs with consistent resource naming, HTTP methods, and status codes.

Updated Apr 12, 2026
One-click install
npx skills add https://github.com/gil00pita/lanify --skill rest-api-design-gil00pita
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rest-api-design
Source: https://github.com/gil00pita/lanify/tree/main/.agents/skills/rest-api-design
Command: npx skills add https://github.com/gil00pita/lanify --skill rest-api-design-gil00pita

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Designs RESTful APIs with consistent resource naming, proper HTTP methods, and standardized status codes and error handling to reduce integration friction and maintenance costs.

Core Features & Use Cases

  • Resource naming as nouns, not actions
  • Correct HTTP methods and status codes with clear error formats
  • Stateless design and straightforward versioning guidance
  • Comprehensive guidance for URL design, pagination, filtering, and error handling
  • Use cases: designing new APIs, refactoring existing endpoints, and establishing team-wide API standards

Quick Start

Apply these guidelines to your API design work by auditing an existing endpoint and updating it to use nouns, proper methods, and standard errors.

Frequently Asked Questions about rest-api-design

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

FAQPage Schema
How do I design a REST API with consistent resource naming and proper HTTP methods?

REST API design uses resource nouns instead of verbs, applies correct HTTP methods, and enforces statelessness to establish predictable integrations. This approach standardizes resource naming and reduces endpoint maintenance costs.

What is the best way to handle errors and HTTP status codes in a REST API?

The best way to handle REST API errors is to use standardized HTTP status codes alongside clear, consistent error formats. This standardization reduces integration friction by making failures predictable for clients.

How do I structure REST API endpoints for pagination, filtering, and versioning?

Structuring REST API endpoints requires straightforward versioning guidance and comprehensive rules for URL design, pagination, and filtering. This enables scalable, stateless integrations that remain predictable as the API grows.

Can I use these REST API guidelines to refactor existing endpoints and establish team standards?

Yes, you can use these REST API guidelines to refactor existing endpoints and establish team-wide API standards. Apply the rules by auditing current endpoints and updating them to use nouns, proper methods, and standard errors.

Why should my REST API use resource nouns instead of actions in the URL design?

Your REST API should use resource nouns instead of actions to maintain a stateless design. This resource-based naming convention enforces predictable, scalable integrations and reduces friction across client implementations.