api-designer

Architect consistent, secure REST, GraphQL, and gRPC API surfaces with OpenAPI documentation.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/Vincri126/MCO-Template --skill api-designer-vincri126
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/Vincri126/MCO-Template/tree/main/.orchestrator/skills/api-designer
Command: npx skills add https://github.com/Vincri126/MCO-Template --skill api-designer-vincri126

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python3, yq, jq, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Engineering teams struggle to design APIs that are consistent, secure, well-documented, and easy to evolve; this skill captures best practices for REST, GraphQL, gRPC, versioning, and QA gates so design reviews stay focused.

Core Features & Use Cases

  • REST & GraphQL guidance: Resource-oriented design, HTTP method semantics, status code hygiene, filtering, sorting, and pagination instructions that keep every endpoint predictable.
  • OpenAPI, Swagger, and schema templates: Ready-to-use spec snippets, components, and versioning patterns plus a discussion of authentication, rate limiting, and security schemes to streamline documentation.
  • QA gate orchestration: Scripts and checklists validate OpenAPI specs, REST naming conventions, error handling, security headers, and documentation completeness before release, so teams avoid regressions.

Quick Start

Ask for a review of your API blueprint covering REST resource naming, GraphQL schema shape, OpenAPI documentation, and QA gate outcomes.

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 pagination and rate limiting?

Design REST APIs with consistent pagination and rate limiting by applying resource-oriented design patterns, HTTP method semantics, and standardized filtering instructions. This approach ensures every endpoint remains predictable and secure.

What is the best way to generate OpenAPI documentation and spec snippets?

The best way to generate OpenAPI documentation is using ready-to-use spec snippets, schema components, and versioning patterns. This streamlines authentication, rate limiting, and security scheme documentation.

How do I validate OpenAPI specs and REST naming conventions before release?

Validate OpenAPI specs and REST naming conventions before release by running QA gate scripts and checklists. These verify error handling, security headers, and documentation completeness to prevent regressions.

Does this API architecture approach support both GraphQL and gRPC planning?

Yes, this API architecture approach supports GraphQL and gRPC planning alongside REST. It provides guidance for schema shape, resource-oriented design, and scalable service surfaces across multiple protocols.

Why should I use RFC 7807 error formatting in API design?

Use RFC 7807 error formatting in API design to maintain consistent, standardized error responses across your API surface. This ensures predictable status code hygiene and reliable client-side error handling.

Do I need Python3, jq, and yq installed to run API QA gate checks?

Yes, you need Python3, jq, and yq installed to run API QA gate checks. These dependencies execute the scripts that validate OpenAPI specifications, REST naming conventions, and security headers.