skills.rest
Vivekmano27
Vivekmano27COMMUNITY
Explore all skills by this author →
GitHub

api-designer

Create standards-compliant REST and GraphQL API specifications in OpenAPI YAML or Markdown.

Updated Mar 14, 2026
Search Tags:#design#documentation#api#openapi#rest#graphql#swagger
One-click install
npx skills add https://github.com/Vivekmano27/agent-orchestrator --skill api-designer-vivekmano27
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/Vivekmano27/agent-orchestrator/tree/main/plugins/project-orchestrator/skills/api-designer
Command: npx skills add https://github.com/Vivekmano27/agent-orchestrator --skill api-designer-vivekmano27

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

API design often suffers from inconsistent contracts, missing versioning, and unclear documentation, leading to slow integrations and miscommunication between frontend and backend teams.

Core Features & Use Cases

  • End-to-end API design for REST and GraphQL, including endpoints, request/response formats, authentication schemes, rate limiting, and error handling.
  • Outputs in OpenAPI/Swagger YAML or Markdown, ready for tooling, documentation, and mock-server pipelines.
  • Versioned contracts that support pagination, consistent status codes, and clear API evolution guidelines.

Quick Start

Design the API for a new user service by generating an OpenAPI spec with CRUD endpoints, JWT authentication, and standard error handling.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I generate a complete OpenAPI specification for a new REST service?▼

To generate a complete OpenAPI specification, you define endpoints, request and response schemas, JWT authentication, and standard error handling. The output is production-ready OpenAPI or Swagger YAML ready for documentation pipelines.

What is the best way to design versioned API contracts for both REST and GraphQL?▼

Designing versioned API contracts involves defining consistent status codes, pagination rules, and API evolution guidelines. This ensures both REST and GraphQL services maintain clear schemas and standardized usage documentation across versions.

Can I output Markdown instead of YAML for my API documentation?▼

Yes, you can output API documentation as Markdown instead of OpenAPI or Swagger YAML. This allows you to define contracts, schemas, and usage guidelines in a format suited for static documentation sites and team wikis.

Does this approach handle API migrations and frontend-backend contract alignment?▼

Yes, this approach handles API migrations by defining strict contracts, schemas, and usage guidelines. It solves inconsistent contracts and unclear documentation, preventing miscommunication between frontend and backend teams during integrations.

How do I add authentication schemes and rate limiting to my Swagger file?▼

To add authentication schemes and rate limiting to your Swagger file, you define JWT authentication and rate limiting rules within the API specification. This produces a standards-compliant contract detailing secure access and usage limits.

Related Skills

Explore More Software Engineering Skills→
nicholasgriffintnnicholasgriffintn
2

backend-design

Plan backend systems, APIs, and data models with structured architecture decisions.

Community
Basic
HouseGarofaloHouseGarofalo
3

openapi-swagger

Design, document, and generate APIs from OpenAPI and Swagger specifications.

Official
Advanced
ramybarsoumramybarsoum

api-design

Design RESTful API contracts with endpoint specs, JSON Schema, and error codes.

Community
Intermediate
luyi985luyi985

codegen-over-complex-types

Generate TypeScript types from OpenAPI, GraphQL, or database schemas.

Community
Advanced