skills.rest
Okashanadeem
OkashanadeemCOMMUNITY
Explore all skills by this author →
Website𝕏@OkashaDevGitHub

rest-api-design-and-errors

Enforce REST API design principles and RFC 7807 error responses.

1|Updated Dec 6, 2025
Search Tags:#error handling#api design#rest api#http status codes#problem details#api consistency
One-click install
npx skills add https://github.com/Okashanadeem/GIAIC-HACKATHON-II --skill rest-api-design-and-errors-okashanadeem
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: rest-api-design-and-errors
Source: https://github.com/Okashanadeem/GIAIC-HACKATHON-II/tree/main/.claude/skills/rest-api-design-and-errors
Command: npx skills add https://github.com/Okashanadeem/GIAIC-HACKATHON-II --skill rest-api-design-and-errors-okashanadeem

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill ensures that all REST APIs designed and implemented follow a consistent set of best practices for resource naming, HTTP methods, status codes, and error response formats, leading to more predictable and maintainable APIs.

Core Features & Use Cases

  • Consistent Resource Naming: Enforces the use of plural nouns for collections and standard ID patterns for resources.
  • Standardized HTTP Methods: Guides the correct usage of GET, POST, PUT, PATCH, and DELETE.
  • Predictable Pagination & Filtering: Defines standard query parameters for efficient data retrieval.
  • Uniform Error Handling: Mandates the use of RFC 7807 Problem Details for all API error responses, ensuring a consistent structure for type, title, status, detail, and instance.
  • Use Case: When building a new microservice or adding endpoints to an existing one, this Skill ensures that its API contract aligns with all other services in the ecosystem, simplifying integration and client development.

Quick Start

Use the rest-api-design-and-errors skill to design a new endpoint for retrieving user tasks, ensuring it follows the standard /api/v1/users/{user_id}/tasks pattern and uses Problem Details for errors.

Frequently Asked Questions about rest-api-design-and-errors

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

FAQPage Schema
How do I standardize REST API error responses across multiple microservices?▼

Standardize REST API error responses by adopting RFC 7807 Problem Details, which enforces a consistent JSON structure for type, title, status, detail, and instance fields across all distributed services.

What are the best practices for REST API resource naming and HTTP methods?▼

REST API resource naming best practices include using plural nouns for collections and standard ID patterns. HTTP method semantics should map correctly: GET for retrieval, POST for creation, PUT for replacement, PATCH for partial updates, and DELETE for removal.

How do I implement consistent pagination and filtering in REST API endpoints?▼

Implement consistent pagination and filtering by defining standard query parameters for data retrieval. This ensures predictable data retrieval across all backend services and simplifies client integration.

Does this REST API design approach work with any backend framework?▼

Yes, this REST API design approach is framework-agnostic. It enforces general REST principles and RFC 7807 Problem Details for standardized error responses, ensuring consistency regardless of the underlying backend technology.

Why should I use RFC 7807 Problem Details for API error handling?▼

RFC 7807 Problem Details provides a standardized format for API error handling, ensuring uniform error structures across multiple projects. This leads to more predictable, maintainable APIs and simplifies client-side error parsing.

How do I design a REST API endpoint for retrieving nested user resources?▼

Design a REST API endpoint for nested resources by following standard hierarchical patterns like /api/v1/users/{user_id}/tasks. This aligns the API contract with ecosystem conventions and ensures consistent resource referencing.

Related Skills

Explore More Software Engineering Skills→
adiytharpansaadiytharpansa

api-builder

Build and manage REST and GraphQL APIs with authentication and documentation.

Community
Intermediate
petbrainspetbrains
13

backend-trpc-openapi

Generate REST endpoints and OpenAPI documentation from tRPC routers.

Official
Intermediate
HyperscapeAIHyperscapeAI
91

api-gateway-configurator

Configure API gateways with rate limiting and JWT authentication.

Official
Advanced
bobmatnycbobmatnyc
68

graphql

Query APIs with a strongly-typed schema to request specific data.

Community
Advanced