rest-api

Design RESTful APIs with HTTP semantics, pagination, versioning, and OpenAPI 3.1 documentation.

Updated Jan 24, 2026
One-click install
npx skills add https://github.com/tresic-cloud/rest-api-skill --skill rest-api-tresic-cloud
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rest-api
Source: https://github.com/tresic-cloud/rest-api-skill/tree/main
Command: npx skills add https://github.com/tresic-cloud/rest-api-skill --skill rest-api-tresic-cloud

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidance and best practices for designing, building, and maintaining robust RESTful APIs, ensuring adherence to industry standards.

Core Features & Use Cases

  • API Design: Resource-oriented design, correct HTTP method usage, and status code selection.
  • Implementation Details: Pagination (cursor-based only), idempotency, versioning strategies, and security best practices.
  • Documentation: Guidance on generating OpenAPI 3.1 specifications.
  • Use Case: You need to design a new set of REST endpoints for a user management service, ensuring they are well-structured, secure, and properly documented.

Quick Start

Use the rest-api skill to design REST endpoints for a user management service.

Frequently Asked Questions about rest-api

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

FAQPage Schema
How do I design RESTful API endpoints with correct HTTP methods and status codes?

RESTful API design uses resource-oriented architecture, mapping HTTP methods to actions and selecting status codes accurately. This guidance covers endpoint structure, HTTP semantics, and error handling for robust interfaces.

What is the best way to handle pagination and idempotency in a REST API?

Pagination in REST APIs should use cursor-based approaches for stable results. Idempotency ensures repeated requests produce the same outcome, preventing duplicate operations during network retries.

How do I generate OpenAPI 3.1 documentation for my REST API?

OpenAPI 3.1 documentation generation involves defining paths, schemas, and security schemes. This skill provides guidance on structuring specifications to accurately document REST endpoints and their behaviors.

What security and versioning strategies should I use for REST API development?

REST API security strategies include authentication and authorization best practices. Versioning strategies help manage endpoint changes without breaking clients, ensuring stable API evolution over time.

When should I use cursor-based pagination instead of offset pagination in REST APIs?

Cursor-based pagination is recommended for REST APIs handling large or frequently changing datasets. It provides stable result navigation by using pointers, avoiding performance issues common with offset pagination.

Can I use this REST API skill to review and troubleshoot existing endpoints?

Yes, this skill supports reviewing and troubleshooting existing REST endpoints. It evaluates resource design, HTTP semantics, and error handling against industry standards to identify and resolve API issues.