api-designer

Design REST and GraphQL APIs with OpenAPI 3.1 specifications.

3|2|Updated Feb 27, 2026
One-click install
npx skills add https://github.com/grasberg/sofia --skill api-designer-grasberg
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/grasberg/sofia/tree/main/workspace/skills/api-designer
Command: npx skills add https://github.com/grasberg/sofia --skill api-designer-grasberg

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Inconsistent API design and fragmented developer experience slow down integrations; this Skill provides a guided approach to REST and GraphQL design with clear patterns, open standards, and maintainable schemas.

Core Features & Use Cases

  • OpenAPI 3.1 driven REST API design with consistent URL structures, HTTP methods, and RFC 7807 error formatting.
  • GraphQL schema design with proper types, relationships, pagination, and federation considerations.
  • Authentication and authorization patterns (OAuth 2.0, API keys, JWT) and versioning strategies for backward compatibility.
  • Comprehensive documentation, examples, and getting-started guides to improve developer experience.

Quick Start

Create a starter API design brief applying REST and GraphQL patterns to define endpoints, schemas, and auth strategy.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I design a REST API using OpenAPI 3.1 specifications?

Designing a REST API with OpenAPI 3.1 involves defining consistent URL structures, HTTP methods, and standardized RFC 7807 error formatting. This approach ensures maintainable schemas, clear endpoint conventions, and robust versioning for backward compatibility.

What is the best way to structure GraphQL schema pagination and federation?

Structuring GraphQL schemas requires defining proper types, relationships, and pagination. Applying federation considerations during GraphQL design ensures scalable query handling and consistent data fetching patterns across distributed services.

How does RFC 7807 standardize API error handling?

RFC 7807 standardizes API error handling by defining a consistent problem details format for HTTP APIs. Applying this format in REST API design provides developers with predictable, machine-readable error responses across all endpoints.

Can I use OAuth 2.0, API keys, and JWT for API authentication patterns?

Yes, you can implement OAuth 2.0, API keys, and JWT for API authentication. Applying these multiple auth schemes within OpenAPI specifications secures endpoints while maintaining flexible authorization patterns for different client access levels.

What's the best way to improve developer experience for API documentation?

Improving API developer experience requires generating comprehensive documentation, practical examples, and getting-started guides. Applying OpenAPI standards ensures the documentation remains synchronized with the schema, accelerating client integrations.

When should I apply REST versus GraphQL for API design?

Apply REST for standardized resource manipulation using OpenAPI 3.1, and choose GraphQL for flexible data fetching with nested relationships. Both approaches support distinct pagination, authentication, and versioning strategies tailored to specific data requirements.