skills.rest
kouiso
kouisoCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design

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

Updated Jul 27, 2026
Search Tags:#api design#rest#backend development#web services#api patterns#api best practices
One-click install
npx skills add https://github.com/kouiso/designdiff --skill api-design-kouiso
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/kouiso/designdiff/tree/main/.claude/skills/api-design
Command: npx skills add https://github.com/kouiso/designdiff --skill api-design-kouiso

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidelines and best practices for designing consistent, developer-friendly REST APIs, ensuring maintainability and ease of integration.

Core Features & Use Cases

  • Resource Naming & Structure: Defines conventions for clear and intuitive URL design.
  • HTTP Method Semantics: Clarifies the appropriate use of GET, POST, PUT, PATCH, and DELETE.
  • Status Codes & Error Handling: Standardizes responses for success and failure scenarios.
  • Pagination, Filtering, Sorting: Implements efficient data retrieval for collections.
  • Versioning & Rate Limiting: Manages API evolution and protects against abuse.
  • Use Case: When designing a new set of endpoints for a user management system, use this Skill to ensure all resource URLs, request/response formats, and error handling are consistent with established best practices.

Quick Start

Use the api-design skill to generate a standard JSON error response for a validation failure.

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

REST API resource naming best practices establish clear URL conventions for endpoints, ensuring consistent and maintainable API contracts that are developer-friendly. This Skill provides guidelines for structuring those exact naming conventions.

How do I choose the correct HTTP methods for my REST API endpoints?▼

Choosing correct HTTP methods for REST APIs requires clarifying the semantics of GET, POST, PUT, PATCH, and DELETE. This Skill provides guidelines to map operations to the appropriate methods for safe and idempotent interactions.

How should I structure REST API error responses and HTTP status codes?▼

Structuring REST API error responses and HTTP status codes involves standardizing outputs for success and failure scenarios. This Skill helps generate consistent JSON error formats, such as standard responses for validation failures.

What is the best way to implement pagination, filtering, and sorting for REST API collections?▼

Implementing pagination, filtering, and sorting for REST API collections enables efficient data retrieval. This Skill outlines patterns to manage large datasets without overwhelming the client or the backend server infrastructure.

How do I add authentication, rate limiting, and versioning to a REST API?▼

Adding authentication, rate limiting, and versioning to a REST API protects against abuse and manages API evolution. This Skill provides patterns to secure endpoints and maintain backward compatibility as your web services scale.

Related Skills

Explore More Software Engineering Skills→
ajianazajianaz
4

flutter-enterprise

Scaffold feature-based Flutter projects with clean architecture and dependency injection.

Community
Advanced
tsunami28tsunami28

elaboration-upsert-api-contract

Create OpenAPI 3.x YAML contracts from feature requirements and implementation slices.

Community
Advanced
dpieterszdpietersz

Backend API

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

Community
Intermediate
Camilo8902Camilo8902

rest-to-graphql-migrator

Migrate REST APIs to GraphQL incrementally using schema stitching and REST data source wrappers.

Community
Advanced