skills.rest
marquesfelip
marquesfelipCOMMUNITY
Explore all skills by this author →
GitHub

api-design-guidelines

Standardize REST/HTTP API resource modeling, versioning, and error handling.

Updated Mar 29, 2026
Search Tags:#versioning#rest#backward-compatibility#error-handling#contracts#api-design
One-click install
npx skills add https://github.com/marquesfelip/agents-and-skills --skill api-design-guidelines
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-guidelines
Source: https://github.com/marquesfelip/agents-and-skills/tree/main/skills/api-design-guidelines
Command: npx skills add https://github.com/marquesfelip/agents-and-skills --skill api-design-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Design teams often struggle with inconsistent API contracts, versioning pitfalls, and unclear error handling across services.

Core Features & Use Cases

  • Resource modeling rules and URL conventions to ensure API consistency.
  • Versioning guidance, migration planning, and deprecation strategies.
  • Standardized error schemas and backward-compatibility checks for safe evolve.

Quick Start

Define a REST API by modeling resources, selecting a versioning approach, and specifying a standard error format.

Frequently Asked Questions about api-design-guidelines

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

FAQPage Schema
How do I design REST APIs with consistent resource modeling and URL conventions?▼

Design REST APIs by standardizing resource modeling rules and URL conventions to ensure consistency. This approach enforces consistent resource naming, URL structure, and HTTP method semantics across services and teams.

What is the best way to handle API versioning and plan migrations?▼

Handle API versioning by selecting a versioning approach and planning migrations using deprecation strategies. This ensures safe API evolution by enforcing backward compatibility checks across services.

How do I standardize error handling schemas in HTTP APIs?▼

Standardize error handling schemas by specifying a standard error format for your HTTP APIs. This process applies standardized error schemas to ensure consistent error reporting and safe contract evolution.

How do I check backward compatibility when evolving API contracts?▼

Check backward compatibility by enforcing backward compatibility checks during API evolution. This ensures safe changes to REST API contracts by validating modifications against existing service integrations.

Does this API design guidance apply to reviewing APIs across multiple teams?▼

Yes, this API design guidance applies to designing, reviewing, and evolving REST/HTTP APIs across teams and services. It standardizes contracts, versioning, and error handling for consistent quality.

When should I not use REST API versioning strategies for service evolution?▼

Avoid REST API versioning strategies when they introduce breaking changes without backward compatibility checks. Rely on standardized error schemas and deprecation strategies to ensure safe contract evolution instead.

Related Skills

Explore More Software Engineering Skills→
coaguscoagus
2

rest-api-design

Define REST API guidelines for HTTP semantics, error handling, and versioning.

Community
Advanced
vikisingh23vikisingh23
4

documentation

Generate API references, architecture diagrams, and onboarding guides from code and OpenAPI specs.

Community
Intermediate
TibsfoxTibsfox
69

api-design

Design and validate REST API endpoints, methods, and status codes.

Community
Intermediate
aquariuscookaquariuscook

contract-testing

Automate consumer-driven contract testing for microservices using Pact and schema validation.

Community
Advanced