api-design-graphql

Define GraphQL schema and resolver contracts including nullability authorization and query safety.

7|Updated Feb 14, 2026
One-click install
npx skills add https://github.com/KentoShimizu/sw-agent-skills --skill api-design-graphql
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-graphql
Source: https://github.com/KentoShimizu/sw-agent-skills/tree/main/skills/api-design-graphql
Command: npx skills add https://github.com/KentoShimizu/sw-agent-skills --skill api-design-graphql

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

GraphQL schemas and resolver behavior often drift, leading to breaking changes and unclear boundaries between client and server that hinder safe evolution.

Core Features & Use Cases

  • GraphQL contract definition for types, inputs, mutations, and deprecations with explicit nullability and ownership semantics.
  • Resolver behavior contracts covering authorization, caching, batching, error semantics, and observability.
  • Governance-friendly templates and references for transport decisions and threshold derivations to harmonize across teams.
  • Use when SDL/resolver diffs appear or when field-level authorization and query-cost controls need formal governance.

Quick Start

Draft or update the SKILL.md to capture scope, inputs, and outputs, then align with the canonical references.

Frequently Asked Questions about api-design-graphql

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

FAQPage Schema
How do I prevent breaking changes when evolving a GraphQL schema?

To prevent breaking changes when evolving a GraphQL schema, establish formal contracts that define type boundaries, nullability, and deprecation status. This governance ensures safe evolution across teams.

How do I enforce field-level authorization in GraphQL resolvers?

You can enforce field-level authorization by applying resolver behavior contracts that explicitly define authz rules. This allows formal governance over access controls directly within your GraphQL resolver layer.

What is a GraphQL contract and how does it govern query safety?

A GraphQL contract is a formal definition capturing schema types, inputs, resolver behavior, and error extensions. It governs query safety by formalizing query-cost controls and threshold derivations across teams.

How do I manage GraphQL schema and resolver drift across teams?

Manage GraphQL drift by applying governance-friendly templates and canonical references that harmonize transport decisions and resolver behavior. Apply these contracts whenever SDL or resolver diffs appear.

When do I need formal governance for GraphQL query-cost controls?

You need formal governance for GraphQL query-cost controls when field-level authorization and threshold derivations require harmonization across teams. This is triggered when SDL or resolver behavior changes occur.