skills.rest
thesammykins
thesammykinsCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design-architect

Enforce OpenAPI-first REST and GraphQL design with versioning and RFC 7807 error handling.

Updated Oct 31, 2024
Search Tags:#openapi#rest#graphql#error-handling#federation#api-design#openapi-3.1
One-click install
npx skills add https://github.com/thesammykins/dotfiles --skill api-design-architect
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-architect
Source: https://github.com/thesammykins/dotfiles/tree/main/.agents/skills/api-design-architect
Command: npx skills add https://github.com/thesammykins/dotfiles --skill api-design-architect

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Eliminate API design fragmentation by enforcing OpenAPI-first REST and GraphQL practices.

Core Features & Use Cases

  • OpenAPI-first design for REST resources and GraphQL schemas.
  • Strong governance with versioning strategies and RFC 7807 error handling.
  • Design, document, and evolve contracts before code across microservices.

Quick Start

Define an OpenAPI 3.1 spec for a new resource, outline REST endpoints with versioning, and sketch a GraphQL federation plan.

Frequently Asked Questions about api-design-architect

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

FAQPage Schema
How do I enforce OpenAPI-first design across microservices?▼

You can enforce OpenAPI-first design by defining OpenAPI 3.1 specifications for REST resources and GraphQL schemas before writing code, applying consistent versioning strategies and RFC 7807 error handling across microservices.

What is RFC 7807 error handling and how does it apply to REST API design?▼

RFC 7807 error handling is a standardized problem-details format for REST API responses. It applies to API design by providing a consistent, schema-driven approach to modeling and returning errors across distributed services.

How do I plan GraphQL federation for microservices?▼

Planning GraphQL federation involves sketching a federated schema architecture that unifies GraphQL endpoints across microservices, allowing you to design and document data contracts before code implementation.

Can I use OpenAPI 3.1 specifications for both REST and GraphQL?▼

OpenAPI 3.1 specifications primarily define REST resources, while GraphQL schemas handle graph queries; standardizing API design, documentation, and governance across both paradigms eliminates fragmentation.

What is the best way to version REST APIs and handle errors?▼

The best way to version REST APIs and handle errors is by applying strong governance with defined versioning strategies alongside RFC 7807-compliant error modeling to maintain consistent contracts across microservices.

When do I need an OpenAPI-first workflow for API design?▼

You need an OpenAPI-first workflow for API design when eliminating API design fragmentation across microservices, ensuring contracts are designed, documented, and evolved before any code is written.

Related Skills

Explore More Software Engineering Skills→
gabi-agentgabi-agent

api-designer

Design REST and GraphQL APIs with OpenAPI 3.1 specifications.

Community
Advanced
dinoudondinoudon

api-documentation

Generates API references and SDK scaffolds from OpenAPI specifications.

Community
Advanced
azmankudusazmankudus

blueprint-webapi

Enforce API contracts using a single OpenAPI 3.1 master specification.

Community
Advanced
iAmAdheiliAmAdheil

openapi-spec-generation

Generate and validate OpenAPI 3.1 specifications from codebases and design-first sources.

Community
Intermediate