api-designer

Generate OpenAPI specs and GraphQL schemas for RESTful and GraphQL APIs.

Updated Nov 22, 2025
One-click install
npx skills add https://github.com/Khamel83/oneshot --skill api-designer-khamel83
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/Khamel83/oneshot/tree/main/archive/v9/skills/api-designer
Command: npx skills add https://github.com/Khamel83/oneshot --skill api-designer-khamel83

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Designing and documenting RESTful and GraphQL APIs with proper conventions, generating endpoint specifications, request/response schemas, and comprehensive documentation.

Core Features & Use Cases

  • Generates OpenAPI/Swagger specs for RESTful endpoints.
  • Generates GraphQL schemas and resolvers scaffolding.
  • Provides naming conventions, URL design, error handling, and pagination guidelines.
  • Produces endpoint documentation and examples.

Quick Start

Describe your API requirements and I will generate an OpenAPI or GraphQL specification.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I generate OpenAPI specifications for RESTful endpoints?

Generate OpenAPI specs for RESTful endpoints by describing your API requirements. The tool outputs endpoint specifications, request/response schemas, and comprehensive documentation for web services and microservices.

Can I create GraphQL schemas and resolver scaffolding from text descriptions?

Yes, you can create GraphQL schemas and resolver scaffolding from text descriptions. Provide your API requirements to generate GraphQL schemas, endpoint documentation, and example requests and responses.

What's the best way to document API naming conventions and pagination guidelines?

Document API naming conventions and pagination guidelines by applying standard design rules to your endpoints. The tool provides URL design, error handling, and pagination guidelines alongside generated endpoint documentation.

How do I design APIs for mobile backends and microservices?

Design APIs for mobile backends and microservices by defining your endpoint requirements. The tool generates RESTful or GraphQL specifications, including request/response schemas and documentation, tailored for these architectures.

Does this tool support refactoring existing RESTful and GraphQL APIs?

Yes, this tool supports refactoring existing RESTful and GraphQL APIs. It applies to engineers designing new APIs or refactoring existing ones, generating updated OpenAPI specs, GraphQL schemas, and endpoint documentation.

What do I need to start generating endpoint documentation and example requests?

To start generating endpoint documentation and example requests, simply describe your API requirements. The tool processes your input to produce OpenAPI or GraphQL specifications along with example responses.