god-api-design

Provides expert guidelines for designing secure, maintainable, and efficient APIs.

1|Updated Apr 23, 2026
One-click install
npx skills add https://github.com/ArdurAI/god-skill-suite --skill god-api-design
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: god-api-design
Source: https://github.com/ArdurAI/god-skill-suite/tree/main/skills/god-api-design
Command: npx skills add https://github.com/ArdurAI/god-skill-suite --skill god-api-design

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill addresses the challenges of creating secure, maintainable, and efficient APIs by providing a comprehensive framework for API design best practices.

Core Features & Use Cases

  • REST API Design: Offers guidelines for RESTful API design, including Richardson Maturity Model, HTTP semantics, status codes, versioning, and pagination.
  • GraphQL Design: Provides guidance on GraphQL schema design, resolvers, N+1 problem, DataLoader, subscriptions, and federation.
  • gRPC Design: Includes guidance on gRPC service definitions, Protocol Buffers, streaming types, deadlines, and interceptors.
  • API Security: Covers OAuth 2.0, JWT, API keys, mTLS, and API gateway patterns.
  • API Testing: Offers insights into API testing with Pact, integration testing, and fuzz testing.
  • Use Case: For a software engineer tasked with designing a new API for a high-traffic application, this Skill ensures adherence to best practices and consideration of security and performance implications.

Quick Start

Load the god-api-design skill to begin creating a secure and efficient API design.

Frequently Asked Questions about god-api-design

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

FAQPage Schema
What is the best way to design a REST API for a high-traffic application?

The best way to design a REST API for high-traffic applications is to follow the Richardson Maturity Model, apply proper HTTP semantics, use standard status codes, and implement robust versioning and pagination strategies to ensure maintainability and efficiency.

How do I solve the N+1 problem in GraphQL schema design?

To solve the N+1 problem in GraphQL schema design, you should implement DataLoader patterns within your resolvers to batch and cache database requests, optimizing data fetching efficiency while designing for subscriptions and federation.

Does gRPC support streaming types and deadlines for service definitions?

gRPC supports service definitions using Protocol Buffers and includes native guidance for implementing streaming types, setting deadlines, and configuring interceptors to manage communication boundaries and service efficiency.

What API security best practices should I follow for OAuth 2.0 and mTLS?

API security best practices for OAuth 2.0 and mTLS involve utilizing API gateway patterns, enforcing JWT and API keys correctly, and applying mutual TLS to secure communication channels against unauthorized access.

How do I perform integration and fuzz testing on my API?

To perform integration and fuzz testing on your API, utilize contract testing frameworks like Pact to validate interactions, and apply fuzz testing techniques to uncover edge cases and security vulnerabilities in your endpoints.

When should I choose gRPC over REST or GraphQL for my API design?

Choose gRPC over REST or GraphQL when your API design requires strict service definitions via Protocol Buffers, efficient binary communication, and native support for streaming types and deadlines in high-performance environments.