api-design

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

217|20|Updated Dec 31, 2025
One-click install
npx skills add https://github.com/yonatangross/orchestkit --skill api-design-yonatangross
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/yonatangross/orchestkit/tree/main/plugins/ork/skills/api-design
Command: npx skills add https://github.com/yonatangross/orchestkit --skill api-design-yonatangross

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill standardizes API design by providing patterns for REST/GraphQL framework design, versioning strategies, and RFC 9457 error handling, ensuring consistency and developer-friendliness.

Core Features & Use Cases

  • API Frameworks: Follow REST conventions, design GraphQL schemas, and structure gRPC services.
  • Versioning: Implement URL path, header, or content negotiation versioning strategies.
  • Error Handling: Standardize API errors using RFC 9457 Problem Details for machine-readable responses.
  • Use Case: When designing a new set of API endpoints, use this Skill to ensure adherence to best practices for naming, HTTP methods, status codes, and error reporting.

Quick Start

Use the api-design skill to generate an OpenAPI specification for your new API.

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 API endpoints with proper HTTP methods and status codes?

REST API design follows standard conventions for naming endpoints, selecting HTTP methods, and returning status codes to ensure developer-friendliness. This Skill provides patterns to standardize endpoint structure and consistency across your new API.

What is the best way to version a REST API?

API versioning can be implemented using URL path, header, or content negotiation strategies. This Skill provides design patterns to help you choose and apply the appropriate versioning scheme for your framework requirements.

How does RFC 9457 Problem Details work for API error handling?

RFC 9457 Problem Details standardizes API errors by providing a machine-readable format for error responses. This Skill helps you implement this specification to ensure consistent, developer-friendly error reporting across endpoints.

Can I use this to generate an OpenAPI specification for a new API?

Yes, you can use this Skill to generate an OpenAPI specification for your new API. It provides comprehensive design patterns for endpoint structure, versioning, and errors that translate directly into OpenAPI documentation.

Does this Skill support designing GraphQL schemas?

Yes, this Skill supports designing GraphQL schemas alongside REST conventions and gRPC services. It provides comprehensive patterns to structure your GraphQL framework design with consistent best practices.

When should I use content negotiation versioning over URL path versioning?

Content negotiation versioning is suitable when you want to keep URLs clean, while URL path versioning offers explicit visibility. This Skill provides design patterns to evaluate and implement the best strategy for your API.