skills.rest
duynhne
duynhneCOMMUNITY
Explore all skills by this author →
GitHub

rest-api-expert

Design REST APIs with HTTP semantics, endpoint naming, versioning, and OpenAPI documentation.

Updated Oct 17, 2025
Search Tags:#versioning#error handling#API design#OpenAPI#REST API#HTTP semantics
One-click install
npx skills add https://github.com/duynhne/monitoring --skill rest-api-expert-duynhne
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: rest-api-expert
Source: https://github.com/duynhne/monitoring/tree/main/.agent/skills/rest-api-expert
Command: npx skills add https://github.com/duynhne/monitoring --skill rest-api-expert-duynhne

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST API design and development expertise to ensure scalable, consistent, and well-documented interfaces.

Core Features & Use Cases

  • Endpoint Design: Establish noun-based resources, proper URL schemas, and clear versioned paths.
  • HTTP Semantics & Error Handling: Apply correct methods, status codes, and standardized error envelopes.
  • Versioning & Documentation: Plan versioning strategies and generate OpenAPI specs for maintainability.
  • Use Case: When building an API for a new service, define endpoints, response formats, and error handling that align with organizational standards.

Quick Start

Describe the desired REST API surface to align schemas, error envelopes, and docs with OpenAPI conventions.

Frequently Asked Questions about rest-api-expert

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

FAQPage Schema
How do I design REST API endpoints with proper HTTP semantics and resource-oriented URLs?▼

REST API design applies correct HTTP semantics by establishing noun-based resources and proper URL schemas. It ensures endpoints use clear versioned paths, proper methods, and standardized status codes for scalable interfaces.

What is the best way to handle errors in a REST API using a consistent error envelope?▼

Error handling in a REST API uses standardized error envelopes to ensure consistent responses. By applying proper HTTP status codes and schema validation, it delivers clear, predictable error details across all endpoints.

How do I plan REST API versioning strategies and generate OpenAPI documentation?▼

REST API versioning strategies maintain backward compatibility through clear versioned paths. Generating OpenAPI specifications documents endpoint schemas, request formats, and response structures for long-term maintainability.

Does robust REST API design require specific pagination patterns for large data sets?▼

Robust REST API design includes pagination patterns to manage large data sets efficiently. Applying correct HTTP semantics ensures resource-oriented endpoints return data in predictable chunks, preventing payload overload.

Can I use OpenAPI schema validation to enforce requirements on my REST API responses?▼

OpenAPI schema validation enforces practical requirements on REST API responses. It validates endpoint schemas, ensures consistent error envelopes, and checks proper status codes to align interfaces with organizational standards.

Related Skills

Explore More Software Engineering Skills→
microwindmicrowind
65

RESTful API设计

Design RESTful APIs with resource modeling, HTTP methods, and versioning.

Official
Advanced
feasibleonefeasibleone
1

blong-rest

Implement REST APIs from OpenAPI specs within Blong's gateway.

Official
Intermediate
ringlochidringlochid

performance-query-review

Identify slow database queries and ORM bottlenecks in backend services.

Community
Advanced
duylinhdang1998duylinhdang1998

graphql-expert

Design and implement type-safe GraphQL APIs with DataLoader batching and Relay pagination.

Community
Advanced