How does it handle complex data models?

It parses type hints, TypeScript interfaces, and class definitions to create detailed components and schemas within your OpenAPI document.

Can it generate documentation if my code doesn't have comments?

Yes, it can analyze route structures and controller logic to generate a baseline specification, though it will suggest adding comments for more detailed field descriptions.

Can I import the output into Postman?

Yes, the generated OpenAPI files are standard-compliant and can be directly imported into Postman, Insomnia, or any other API testing client.

Which web frameworks are supported by API Documenter?

API Documenter automatically recognizes several major frameworks including Express.js (Node.js), FastAPI and Django REST (Python), Spring Boot (Java), Gin (Go), and Ruby on Rails.

What output formats does this skill support?

The skill supports OpenAPI 3.0 (JSON/YAML), Swagger 2.0, API Blueprint, and RAML formats.

API Documenter

Name: API Documenter
Author: Tahir-yamin

byTahir-yamin

•

API開発

Auto-generates comprehensive OpenAPI and Swagger specifications directly from your code, comments, and route definitions.

The API Documenter skill automates the creation and maintenance of API specifications by intelligently parsing source code to extract endpoints, request/response schemas, and authentication requirements. By recognizing popular frameworks like Express.js, FastAPI, and Django REST, it bridges the gap between implementation and documentation, ensuring your API remains discoverable and accurate. It goes beyond simple extraction by suggesting missing documentation for parameters and generating realistic examples to help developers integrate with your services more quickly.

主な機能

01Automatic OpenAPI 3.0 and Swagger 2.0 specification generation

02Intelligent framework detection for Node.js, Python, Java, Go, and Ruby

03Comprehensive parsing of JSDoc, Python docstrings, and JavaDoc

04Seamless integration with documentation renderers like Redoc and Swagger UI

05Automated generation of realistic request and response example payloads

063 GitHub stars

ユースケース

01Synchronizing API specifications automatically whenever route or controller files are modified

02Generating professional documentation for legacy codebases that lack existing specs

03Creating mock data and example responses for front-end developers during the design phase

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tahir-yamin/dev-engineering-playbook documentation

For use in Claude.ai and ChatGPT

Download Skill