api-documenter

Generate OpenAPI 3.0 specifications from code across multiple frameworks.

763|165|Updated Sep 16, 2025
One-click install
npx skills add https://github.com/alirezarezvani/claude-code-tresor --skill api-documenter
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-documenter
Source: https://github.com/alirezarezvani/claude-code-tresor/tree/main/skills/documentation/api-documenter
Command: npx skills add https://github.com/alirezarezvani/claude-code-tresor --skill api-documenter

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the tedious and error-prone process of manually writing and updating API documentation. It ensures your API specifications are always in sync with your codebase, saving developers time and reducing inconsistencies.

Core Features & Use Cases

  • Auto-Generate OpenAPI Specs: Automatically creates OpenAPI 3.0 (Swagger) specifications from your code and comments.
  • Multi-Framework Support: Works with popular frameworks like Express.js, FastAPI, Django REST, Spring Boot, Gin, and Rails.
  • Use Case: As you add new API endpoints or modify existing ones in your Express.js application, this skill automatically updates your openapi.json file, ready for integration with Swagger UI or Postman.

Quick Start

The skill activates automatically when API files change.

Write an API endpoint with JSDoc comments:

/**

  • Get user by ID
  • @param {string} id - User ID / app.get('/api/users/:id', async (req, res) => { / ... */ });

The skill will then generate or update your OpenAPI spec.

Frequently Asked Questions about api-documenter

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

FAQPage Schema
How do I auto-generate API documentation from my code?

Auto-generate API documentation by writing your endpoints with JSDoc comments in Express.js, FastAPI, Django REST, Spring Boot, Gin, or Rails. The Skill automatically detects changes and produces OpenAPI 3.0 specifications (JSON/YAML) with endpoint descriptions, request/response schemas, and example payloads.

Can I generate OpenAPI specs from Express.js endpoints automatically?

Yes. Write Express.js endpoints with JSDoc comments documenting parameters and descriptions. The Skill monitors your API files, automatically generates or updates your openapi.json file, and keeps it synchronized with your codebase.

What frameworks does automated API documentation generation support?

Automated API documentation generation supports Express.js, FastAPI, Django REST, Spring Boot, Gin, and Rails. The Skill works across these frameworks to produce consistent OpenAPI 3.0 specifications from your routes and controllers.

Does this generate Swagger-compatible documentation?

Yes. The Skill generates OpenAPI 3.0 specifications that are fully compatible with Swagger UI, Postman, and other OpenAPI-compliant tools for interactive API documentation and testing.

Why keep API documentation in sync with code changes?

Manual API documentation easily becomes outdated and inconsistent with actual endpoints. Automatic generation eliminates tedious updates and ensures your documentation always reflects current code, reducing errors and developer time spent maintaining specs.

What does the generated API documentation include?

Generated OpenAPI specifications include endpoint descriptions, request/response schemas, authentication requirements, example payloads, and error responses—everything needed for developers to understand and integrate with your API.