api-designer

Design and review REST, GraphQL, and gRPC APIs with OpenAPI specifications.

2|2|Updated Jan 16, 2026
One-click install
npx skills add https://github.com/mehdiozdemir/awesome-agent-skills --skill api-designer-mehdiozdemir
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/mehdiozdemir/awesome-agent-skills/tree/main/skills/api-designer
Command: npx skills add https://github.com/mehdiozdemir/awesome-agent-skills --skill api-designer-mehdiozdemir

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Enables teams to craft API designs and reviews that align with industry best practices, reducing ambiguity and leakage during API development.

Core Features & Use Cases

  • Establish REST, GraphQL, and gRPC design patterns, including resource naming, request/response shapes, and error handling.
  • Generate OpenAPI/Swagger specifications, review contracts, and design authentication flows to improve developer experience.
  • Use cases include creating new endpoints, refining existing APIs, and auditing API contracts for consistency and security.

Quick Start

Describe a new API concept and I will produce a complete contract, spec, and design guidance.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I design REST APIs with consistent resource naming and error handling?

Designing REST APIs requires establishing consistent patterns for resource naming, request/response shapes, and error handling. This skill provides design guidance and generates complete OpenAPI specifications to enforce these industry best practices across your endpoints.

What's the best way to generate an OpenAPI or Swagger specification for a new API?

Generating an OpenAPI or Swagger specification is best achieved by describing your new API concept. The skill produces a complete contract, clear specifications, and design guidance to improve developer experience and reduce ambiguity during API development.

Can I review and refine existing GraphQL and gRPC contracts for security?

Reviewing and refining existing GraphQL and gRPC contracts is fully supported. You can audit API contracts for consistency, enforce standard patterns, and design secure authentication flows to improve overall contract quality and security.

How do I audit existing API contracts for consistency and security?

Auditing API contracts involves reviewing existing endpoints against established design patterns. This skill analyzes your REST, GraphQL, and gRPC contracts to identify inconsistencies, enforce security considerations, and provide clear refinement guidance.

Does this skill support designing authentication flows across different API protocols?

Designing authentication flows is supported across REST, GraphQL, and gRPC protocols. The skill helps you establish secure authentication patterns and enforces consistent security considerations throughout your API contracts.

What are the limitations when designing APIs with this approach?

Designing APIs with this approach focuses specifically on contract design and specification generation. It does not handle backend implementation, server deployment, or runtime API management, serving purely as a design and review tool for API contracts.