api-design

Provide guidelines for designing RESTful APIs with resource naming and HTTP methods.

Updated Jul 10, 2025
One-click install
npx skills add https://github.com/nubiv/my-nome --skill api-design-nubiv
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/nubiv/my-nome/tree/main/nix-darwin/config/claude/skills/api-design
Command: npx skills add https://github.com/nubiv/my-nome --skill api-design-nubiv

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidance and best practices for designing robust, scalable, and developer-friendly REST APIs, ensuring consistency and maintainability.

Core Features & Use Cases

  • Resource Naming & URL Structure: Establishes conventions for clear and intuitive API endpoints.
  • HTTP Methods & Status Codes: Details the semantic use of HTTP verbs and status codes for effective communication.
  • Response Formatting: Defines standard structures for success and error responses, including pagination.
  • Pagination, Filtering, Sorting, & Search: Implements strategies for efficient data retrieval and manipulation.
  • Authentication, Authorization, & Rate Limiting: Covers essential security and access control mechanisms.
  • Versioning Strategies: Outlines methods for managing API evolution.
  • Use Case: When designing a new set of endpoints for a user management system, use this Skill to ensure all resources are named correctly, errors are handled semantically, and pagination is implemented efficiently.

Quick Start

Use the api-design skill to generate a standard error response structure for a 400 bad request.

Frequently Asked Questions about api-design

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

FAQPage Schema
What are REST API best practices for resource naming and HTTP status codes?

REST API best practices dictate using intuitive noun-based resource naming and semantic HTTP methods. Correct HTTP status codes ensure effective client communication, forming the foundation of maintainable and developer-friendly web services.

How do I design standard response formats for REST API pagination and error handling?

Design REST API response formats by defining standard structures for success and error payloads, incorporating pagination. Implementing pagination, filtering, and sorting strategies ensures efficient data retrieval and manipulation for clients.

What is the best way to implement authentication, authorization, and rate limiting in web services?

The best way to secure web services is implementing robust authentication, authorization, and rate limiting mechanisms. These controls manage access, protect endpoints, and prevent API abuse while ensuring scalable performance.

How do I handle API versioning strategies when evolving REST endpoints?

Handle API versioning strategies by outlining clear methods for managing REST API evolution. Versioning ensures backward compatibility and consistent maintainability when modifying existing web service endpoints or introducing breaking changes.

Can I use this to generate a standard 400 bad request error response structure?

Yes, you can use this to generate a standard error response structure for a 400 bad request. It provides guidelines to ensure errors are handled semantically, maintaining consistency across all API responses.