openapi-generator

Generate Chinese OpenAPI 3.0.3 documentation from TypeScript controller and service code.

Updated Feb 25, 2026
One-click install
npx skills add https://github.com/QING-YU123/hono-drizzle-template --skill openapi-generator-qing-yu123
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: openapi-generator
Source: https://github.com/QING-YU123/hono-drizzle-template/tree/main/.claude/skills/openapi-generator
Command: npx skills add https://github.com/QING-YU123/hono-drizzle-template --skill openapi-generator-qing-yu123

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation and maintenance of OpenAPI documentation, ensuring your API specifications are accurate, comprehensive, and always in sync with your codebase.

Core Features & Use Cases

  • Automated Documentation: Generates OpenAPI 3.0.3 compliant documentation directly from your TypeScript controller and service files.
  • Standardized Format: Ensures all documentation adheres to strict Chinese OpenAPI writing standards, including detailed business descriptions, examples, and error handling.
  • Use Case: After implementing a new set of API endpoints in your Hono application, use this Skill to instantly generate or update the corresponding OpenAPI documentation, ready for integration with Swagger UI or code generation tools.

Quick Start

Generate the OpenAPI documentation for the user management module.

Frequently Asked Questions about openapi-generator

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

FAQPage Schema
How do I generate OpenAPI documentation from TypeScript code?

Generate OpenAPI documentation from TypeScript code by analyzing your existing controller and service layer files. The tool automatically produces OpenAPI 3.0.3 compliant specifications with detailed business descriptions, examples, and error handling.

Can I update existing OpenAPI docs instead of creating new ones?

Yes, you can update existing OpenAPI docs. The tool supports both creating new documentation and maintaining existing files, ensuring your API specifications stay continuously in sync with your TypeScript codebase.

Does this OpenAPI generator work with Hono framework applications?

Yes, this OpenAPI generator works with Hono framework applications. After implementing API endpoints in your Hono application, it instantly generates corresponding OpenAPI 3.0.3 documentation ready for integration with Swagger UI.

What standards are used when generating OpenAPI specifications from code?

Generating OpenAPI specifications from code adheres to strict Chinese OpenAPI writing standards. This ensures all documentation includes detailed business descriptions, accurate data models, comprehensive examples, and standardized error handling.

What is the best way to maintain API documentation accuracy in a TypeScript project?

The best way to maintain API documentation accuracy in a TypeScript project is to automate it from your source code. This approach generates and updates OpenAPI 3.0.3 docs directly from your controller and service layers, preventing manual documentation drift.

Why are my API descriptions out of sync with my service layer code?

Your API descriptions are out of sync with your service layer code because manual documentation easily drifts from implementation. Automating OpenAPI generation directly from TypeScript files ensures your specs accurately reflect your current endpoints and data models.