api-rest

Implement REST API conventions for URLs, HTTP methods, status codes, and pagination.

1|Updated Dec 22, 2025
One-click install
npx skills add https://github.com/CybLow/pypaginate --skill api-rest-cyblow
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-rest
Source: https://github.com/CybLow/pypaginate/tree/main/.opencode/skills/api-rest
Command: npx skills add https://github.com/CybLow/pypaginate --skill api-rest-cyblow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST API design conventions solve the problem of inconsistency and ambiguity in API contracts by standardizing structure, URLs, HTTP methods, status codes, pagination, filtering, sorting, versioning, and error responses.

Core Features & Use Cases

  • Resource-oriented URLs and HTTP methods
  • Consistent status codes and error responses
  • Pagination, filtering, and sorting support
  • Versioning strategies and documentation patterns
  • Real-world use case: designing a user management API with /users endpoints

Quick Start

Define a REST API using resource-oriented URLs, standard HTTP methods, and robust error handling.

Frequently Asked Questions about api-rest

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

FAQPage Schema
How do I design consistent REST API endpoints for a new service?

Apply REST API conventions for robust error handling by using consistent status codes and standardized error responses. This ensures clients receive predictable feedback for failed requests across all services.

What is the best way to implement pagination and filtering in a REST API?

Implement REST API pagination and filtering by applying standardized conventions for sorting and scalable data retrieval. This enforces consistent query patterns across resource collections to manage large datasets effectively.

How does API versioning work in REST API design?

REST API versioning works by applying standardized strategies to resource URLs to manage breaking changes. This preserves backward compatibility across services while maintaining predictable endpoint structures.

When do I need standardized error responses in my REST API?

You need standardized error responses in your REST API when building services requiring predictable endpoints. Standardizing status codes and error formats solves inconsistency and ambiguity in API contracts for clients.