skills.rest
diego-tobalina
diego-tobalinaCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-rest-design

Design and implement REST APIs with URL design, HTTP methods, and status codes.

1|Updated Jan 19, 2026
Search Tags:#api design#rest api#pagination#api versioning#status codes#http methods
One-click install
npx skills add https://github.com/diego-tobalina/vibe-coding --skill api-rest-design-diego-tobalina
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-rest-design
Source: https://github.com/diego-tobalina/vibe-coding/tree/main/.opencode/skills/api-rest-design
Command: npx skills add https://github.com/diego-tobalina/vibe-coding --skill api-rest-design-diego-tobalina

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill unit helps to design and implement REST APIs following best practices, ensuring consistency, scalability, and ease of use.

Core Features & Use Cases

  • URL Design Standards: Ensures correct naming conventions, hierarchy, and structure for RESTful APIs.
  • HTTP Methods: Defines the correct usage of HTTP methods for CRUD operations and error handling.
  • Status Codes: Standardizes response status codes for successful requests, client errors, and server errors.
  • Error Response Format: Outlines a consistent error response structure for error handling and user feedback.
  • Pagination: Provides guidelines for implementing pagination in API responses.
  • API Versioning: Explains best practices for versioning APIs and maintaining backward compatibility.
  • Request/Response Examples: Includes examples for CRUD operations and error handling to illustrate best practices.
  • Common API Design Mistakes: Identifies and explains common mistakes in API design to help avoid them.
  • Best Practices: Lists best practices for designing REST APIs that are secure, scalable, and user-friendly.

Quick Start

Use the api-rest-design skill to design a REST API endpoint for user management, including endpoints for creating, retrieving, updating, and deleting users.

Frequently Asked Questions about api-rest-design

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

FAQPage Schema
How do I design a REST API with correct URL structures and HTTP methods?▼

REST API design uses specific naming conventions, hierarchy, and HTTP methods for CRUD operations. Correct URL design ensures logical resource structuring, while standard HTTP methods like GET, POST, PUT, and DELETE map directly to creating, retrieving, updating, and deleting resources.

What are the best practices for standardizing HTTP status codes and error handling in a REST API?▼

Standardizing HTTP status codes in a REST API involves using specific ranges for success, client errors, and server errors. Consistent error handling requires a standardized error response structure, providing clear feedback for client-side issue resolution and debugging.

How does pagination work in REST API responses?▼

Pagination in REST API responses splits large data sets into manageable chunks using query parameters. This approach limits the number of returned items per request, improving API scalability and reducing client-side payload processing times.

What is the best way to handle API versioning for backward compatibility?▼

API versioning maintains backward compatibility by explicitly signaling API changes through the URL path or headers. This practice allows clients to transition smoothly to newer versions without breaking existing integration logic.

What are common mistakes in REST API design and how do I avoid them?▼

Common REST API design mistakes include improper use of HTTP methods, inconsistent URL naming, and poorly structured error responses. Avoiding these requires adhering to established RESTful design principles to ensure the API remains secure, scalable, and user-friendly.

Do I need prior web development experience to implement these REST API guidelines?▼

Yes, implementing these REST API guidelines assumes familiarity with RESTful design principles and web development. Existing knowledge of web protocols is necessary to effectively apply the provided standards for URL design, status codes, and pagination.

Related Skills

Explore More Software Engineering Skills→
KuaaMUKuaaMU
4

api-design

Guide REST API design covering naming, methods, status codes, and versioning.

Community
Advanced
niltsiarniltsiar
1

ktor-backend

Build Ktor server endpoints with routing, validation, and OpenAPI documentation.

Community
Advanced
asterdexasterdex
69

aster-api-spot-errors-v1

Interpret Aster Spot API v1 error codes, rate limits, and security errors.

Official
Basic
ryan-nguyen-01ryan-nguyen-01
4

skill-api-graphql

Design GraphQL APIs with schema, resolver, DataLoader, and security best practices.

Community
Advanced