api-docs-generator

Generate OpenAPI 3.0 documentation from NestJS and Django REST Framework codebases.

Updated Mar 14, 2026
One-click install
npx skills add https://github.com/Vivekmano27/agent-orchestrator --skill api-docs-generator-vivekmano27
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-docs-generator
Source: https://github.com/Vivekmano27/agent-orchestrator/tree/main/plugins/project-orchestrator/skills/api-docs-generator
Command: npx skills add https://github.com/Vivekmano27/agent-orchestrator --skill api-docs-generator-vivekmano27

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate accurate API documentation directly from codebases to save time and prevent drift between implementation and docs.

Core Features & Use Cases

  • Auto-generate OpenAPI 3.0 specs from NestJS and Django REST Framework projects, including endpoint descriptions, request/response schemas, and authentication guidance.
  • Export and publish Swagger/OpenAPI specs for consumer use, with sample requests/responses and error references.
  • Keep documentation in sync as code evolves by re-scanning codebases and re-generating docs on demand.
  • Validate OpenAPI against schema standards and provide lint feedback to ensure consistency.

Quick Start

Run api-docs-generator on your NestJS or Django REST project to generate an OpenAPI YAML document and companion docs.

Frequently Asked Questions about api-docs-generator

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

FAQPage Schema
How do I auto-generate OpenAPI 3.0 documentation from NestJS code?

To generate OpenAPI 3.0 documentation from NestJS, scan the project's API layer to extract endpoint descriptions, DTO schemas, and authentication guidance into a standardized spec. This process annotates controllers and exports the results as YAML or JSON files.

Can I generate Swagger specs from Django REST Framework projects automatically?

Yes, you can generate Swagger specs from Django REST Framework by scanning the codebase to map request/response schemas and error references. It exports the extracted API structures into OpenAPI YAML or JSON formats for consumer use.

How do I keep API documentation in sync as my codebase evolves?

Keep API documentation synchronized by re-scanning the evolved codebase and re-generating the OpenAPI specs on demand. This re-scanning extracts updated endpoint details and schemas, preventing implementation drift between code and published docs.

Does this approach validate generated OpenAPI specs against schema standards?

Yes, this approach validates generated OpenAPI specs against schema standards and provides lint feedback. Validating the extracted endpoint schemas and error references ensures structural consistency and compliance before publishing the API documentation.

What is the best way to export API docs with sample requests and responses?

The best way to export API docs with sample requests and responses is to scan the API layer to extract schemas, authentication guidance, and error references. This generates a comprehensive OpenAPI YAML or JSON document for consumers.

Do I need specific dependencies to generate OpenAPI docs from my API layer?

No specific dependencies are required to generate OpenAPI docs, provided the project is written in NestJS or Django REST Framework. The tool scans the existing API layer directly to annotate controllers and produce schema specs.