skills.rest
wesleyosantos91
wesleyosantos91COMMUNITY
Explore all skills by this author →
GitHub

api-design

Design REST APIs with endpoint conventions, status codes, and RFC 9457 error structures.

6|1|Updated Mar 30, 2026
Search Tags:#versioning#error handling#api design#openapi#rest#pagination#http semantics
One-click install
npx skills add https://github.com/wesleyosantos91/multi-agents --skill api-design-wesleyosantos91
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/wesleyosantos91/multi-agents/tree/main/devin/.devin/skills/api-design
Command: npx skills add https://github.com/wesleyosantos91/multi-agents --skill api-design-wesleyosantos91

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps you avoid brittle or confusing REST API designs by providing consistent conventions for endpoints, HTTP semantics, error handling, and versioning.

Core Features & Use Cases

  • REST endpoint and contract design: Define resource-oriented URLs, HTTP method semantics, and pagination/filtering patterns.
  • Production-friendly error responses: Use Problem Details (RFC 9457) to standardize error shapes and status codes.
  • API readiness deliverables: Produce endpoint tables plus request/response and error expectations suitable for implementation or OpenAPI writing.

Quick Start

Use the api-design skill to design a REST API for your resource domain and output endpoints, examples, pagination/filtering rules, and RFC 9457-style errors.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design REST APIs with consistent endpoint conventions and HTTP semantics?▼

To design REST APIs with consistent conventions, define resource-oriented URLs and map HTTP method semantics to operations. This ensures your endpoints are understandable and production-ready for client integration.

What is the best way to standardize REST API error handling?▼

The best way to standardize REST API error handling is by specifying RFC 9457 Problem Details structures. This standardizes error shapes and maps status codes to specific failure scenarios.

How do I implement pagination and filtering patterns for REST APIs?▼

Implementing pagination and filtering for REST APIs requires defining specific URL conventions for queries. This establishes consistent resource retrieval patterns for large datasets during client integration.

Does API versioning need to follow specific URL conventions?▼

API versioning does follow specific URL conventions to maintain consistent and understandable services. Defining versioning rules alongside endpoint design prevents brittle contracts when revising services.

Can I generate OpenAPI specifications from REST API endpoint designs?▼

You can generate OpenAPI specifications by producing endpoint tables, request and response expectations, and error contracts. These API readiness deliverables are suitable for OpenAPI writing.

Related Skills

Explore More Software Engineering Skills→
armanzeroeightarmanzeroeight
29

rest-api-designer

Design RESTful API endpoints with resource models, HTTP methods, and URL structures.

Community
Intermediate
Muath2000Muath2000

api-contracts-auditor

Audit OpenAPI specifications against Zod DTO schemas for endpoint parity.

Community
Advanced
yonatangrossyonatangross
217

api-design

Design REST and GraphQL APIs with versioning and RFC 9457 error handling.

Community
Intermediate
coco-researchcoco-research
264

api-design-principles

Design REST and GraphQL APIs with resource-oriented naming and HTTP semantics.

Community
Advanced