api-design

Analyzes REST and GraphQL APIs and generates design guidance covering naming, versioning, security, and performance.

1|Updated Oct 11, 2025
One-click install
npx skills add https://github.com/codewizwit/human-in-the-loop --skill api-design-codewizwit
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/codewizwit/human-in-the-loop/tree/main/lib/skills/api-design
Command: npx skills add https://github.com/codewizwit/human-in-the-loop --skill api-design-codewizwit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Designing or auditing an API requires deep knowledge of REST and GraphQL conventions, security practices, and versioning strategies, and inconsistencies often slip into production endpoints. This Skill inspects your actual codebase and produces concrete, standards-based design recommendations. ## Core Features & Use Cases - Codebase-Aware Analysis: Uses Read, Glob, and Grep to locate routes, controllers, resolvers, and schemas, then identifies your framework (Express, NestJS, Fastify, Apollo) before reviewing. - Comprehensive Design Guidance: Covers RESTful resource naming, HTTP methods and status codes, GraphQL schema design, versioning strategies, authentication, rate limiting, pagination, and error response structures. - Interactive Scoping: Asks whether you are working with REST, GraphQL, or both, and whether your goal is security hardening, performance, developer experience, or a full review. - Use Case: Ask it to audit an Express REST API for an e-commerce app, and it will inventory endpoints, flag missing authentication checks, recommend a URL versioning strategy, and output a structured markdown report with sample requests and responses. ## Quick Start Ask the assistant to review the API design of this project and suggest improvements for security and naming conventions.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I review a REST API design for best practices?▼

Ask the assistant to review your API design, and it will scan your routes and controllers to evaluate resource naming, HTTP method usage, status codes, and response structures. It then produces a markdown report with specific improvements and sample request/response examples.

How to audit a GraphQL schema for performance issues?▼

The skill locates your GraphQL schema and resolvers, then checks for N+1 query patterns, improper nullable field usage, missing pagination via the connection pattern, and unclear mutation design. Specify performance as your optimization goal when prompted.

Does this work with Express, NestJS, and Fastify APIs?▼

Yes, the discovery phase reads package.json to identify frameworks including Express, NestJS, Fastify, and Apollo. It adapts its analysis of routes, controllers, and resolvers based on the detected framework.

What API versioning strategy should I use for REST endpoints?▼

URL versioning such as /v1/users is the most common and recommended approach. The skill also evaluates header-based versioning, advises versioning only on breaking changes, and recommends deprecation policies with sunset headers.

What are the limitations of an automated API design review?▼

The review is static analysis of code and schemas, so it cannot measure actual runtime latency, real-world load behavior, or live authentication flows. Load testing and penetration testing tools are still needed for those concerns.