skills.rest
Jonathan0823
Jonathan0823COMMUNITY
Explore all skills by this author →
𝕏@GuinnJo1GitHub

api-rest-design

Design versioned REST APIs with resource naming, HTTP methods, and OpenAPI documentation.

7|Updated Feb 5, 2026
Search Tags:#openapi#api versioning#http methods#api guidelines#rest API design#resource modeling
One-click install
npx skills add https://github.com/Jonathan0823/opencode-config --skill api-rest-design
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-rest-design
Source: https://github.com/Jonathan0823/opencode-config/tree/main/skills/api-rest-design
Command: npx skills add https://github.com/Jonathan0823/opencode-config --skill api-rest-design

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides structured guidance to design intuitive, versioned RESTful APIs, reducing inconsistent endpoints and brittle integrations.

Core Features & Use Cases

  • Resource-based design: guidelines on selecting nouns for endpoints and applying proper HTTP methods.
  • Versioning and lifecycle: strategies for path and header versioning, deprecation, and migration planning.
  • Error handling and responses: standard error formats, pagination, and consistent success responses.
  • Use Case: design endpoints for a store with products, users, and orders such as /v1/products and /v2/orders, with clear field schemas and examples.

Quick Start

Create a versioned API outline for a small service: define resources, URIs, sample requests, and an OpenAPI skeleton.

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 REST API endpoints that prevent brittle integrations?▼

REST API design prevents brittle integrations by applying structured guidelines for resource-based endpoint naming, proper HTTP method semantics, and uniform error handling. This ensures consistent interfaces and stable service contracts across product teams.

What is the best way to version a REST API during migration?▼

REST API versioning uses path or header strategies to manage lifecycle changes. It provides deprecation and migration planning guidelines, allowing services to evolve smoothly without breaking existing client integrations.

How do I structure standard error formats and pagination in a REST API?▼

Standard REST API error formats and pagination structures are applied through consistent response schemas. This provides uniform success responses and predictable error handling, enabling reliable client-side data parsing and integration.

Can I generate an OpenAPI skeleton directly from my API resource model?▼

OpenAPI skeletons are generated by defining your resources, URIs, and sample requests. This produces a versioned API outline with clear field schemas and examples, satisfying requirements for standard API documentation.

Does this REST API design approach work for small internal tools and public APIs?▼

This REST API design approach scales for both small internal tools and public APIs. It applies consistent resource modeling and endpoint guidelines across varying service scopes, ensuring clear interfaces regardless of project scale.

Related Skills

Explore More Software Engineering Skills→
dhruvinrsonidhruvinrsoni

api-contract-design

Design REST or gRPC API contracts using OpenAPI or Protobuf specifications.

Community
Advanced
xloxn69xloxn69
7

api-documentation-generator

Generate OpenAPI 3.0 YAML/JSON specifications for REST API endpoints.

Community
Basic
xmark168xmark168
4

api-route

Generate Next.js 16 API Route Handlers with Zod validation and Prisma database operations.

Community
Advanced
erichowenserichowens
181

api-architect

Design and validate REST, GraphQL, and gRPC API contracts and architectures.

Community
Advanced