skills.rest
enchantednatures
enchantednaturesCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design

Design standardized REST, GraphQL, and gRPC APIs with versioning and error handling.

Updated May 7, 2025
Search Tags:#versioning#documentation#rest#graphql#naming#grpc#api-design
One-click install
npx skills add https://github.com/enchantednatures/.dotfiles --skill api-design-enchantednatures
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/enchantednatures/.dotfiles/tree/main/.config/opencode/skills/api-design
Command: npx skills add https://github.com/enchantednatures/.dotfiles --skill api-design-enchantednatures

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Designing APIs that are consistent, intuitive, and future-proof across REST, GraphQL, and gRPC.

Core Features & Use Cases

  • Establishes standard conventions for resources, endpoints, versioning, and error handling.
  • Guides naming, pagination, security, and comprehensive documentation.
  • Use cases include creating public APIs, evolving existing APIs, and designing integrations.

Quick Start

Draft a complete API design blueprint for a new REST service including resource naming, versioning, and error handling.

Frequently Asked Questions about api-design

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

FAQPage Schema
What is the best way to design consistent APIs across REST, GraphQL, and gRPC?▼

API design establishes standard conventions for resources, endpoints, versioning, and error handling to ensure consistent, developer-friendly interfaces across REST, GraphQL, and gRPC. It creates clear contracts and stable resource models.

How do I draft a complete REST API design blueprint for a new service?▼

Draft a REST API design blueprint by defining resource naming, applying stable versioning, and standardizing error handling. This process ensures your new service exposes clear, developer-friendly contracts and comprehensive documentation.

How do I handle API versioning and error handling when evolving existing APIs?▼

Handle API versioning and error handling when evolving existing APIs by applying standard conventions that maintain stable contracts and consistent resource models. This ensures backward compatibility and robust developer experiences during API changes.

Do I need OpenAPI and GraphQL schema documentation for public API exposure?▼

You need OpenAPI and GraphQL schema documentation for public API exposure to set requirements for clear contracts and comprehensive documentation. This ensures your public APIs are developer-friendly and consistently standardized.

What are the limitations of designing APIs without standard naming and pagination conventions?▼

Designing APIs without standard naming and pagination conventions leads to inconsistent resource models, unstable versioning, and poor developer experiences. Lacking clear contracts and comprehensive documentation hinders robust API integrations and public exposure.

Related Skills

Explore More Software Engineering Skills→
takemo101takemo101

basic-design-writer

Generate foundational system design documents in Japanese with Mermaid diagrams.

Community
Intermediate
franroafranroa

API Designer

Design REST and GraphQL APIs with OpenAPI 3.1 specifications.

Community
Advanced
vladm3105vladm3105
16

contract-tester

Validate API contracts and detect breaking changes across OpenAPI/AsyncAPI specifications.

Community
Advanced
zenbuappszenbuapps

aibdd-form-api-spec

Derive OpenAPI specifications from .feature files into api.yml.

Official
Intermediate