API Docs Generator Pack

★Trustedv1.0.0MIT✔Verified88

by AgentNode · published 22 days ago · toolpack

Generate API documentation from code with examples and schemas.

Auto-generate OpenAPI/Swagger documentation, README files, and usage examples from source code. Supports REST, GraphQL, and gRPC APIs.

langchaincrewaigeneric

Quick Start

bash

agentnode install api-docs-generator-pack

Usage

From package

python

from api_docs_generator_pack.tool import run

result = run(
    capability="generate_api_docs",
    params={
        "source_path": "./src/main.py",
        "framework": "fastapi",
        "output_format": "markdown",
        "include_examples": True
    }
)

print(f"Documented {result['endpoints_found']} endpoints")
print(f"Output written to: {result['output_path']}")
for ep in result["endpoints"][:3]:
    print(f"  {ep['method']} {ep['path']} — {ep['summary']}")

Verification

high confidence88/100✔ Verified

smokeReturned valid result

+25/25

testsAuto-generated tests only

+8/15

importAll tools imported successfully

+15/15

installInstalled in 1.7s

+15/15

contractAll contract checks passed

+10/10

warningsNo warnings

0/0

determinismOutput consistency check

+5/5

reliability3/3 runs passed

+10/10

Package installs and imports correctly. runtime checks passed.

✔install1.7s

✔import98ms

✔smoke150ms

✔tests1.0s

This package was executed and validated by AgentNode before listing. Install, import, and runtime checks passed.

Python 3.12.3ffmpegpopplertesseractuv

Last verified 18d ago· Runner v2.0.0

Use this when you need to...

›Generate OpenAPI specs from Python source files
›Create endpoint documentation with request/response examples
›Produce HTML API reference from Flask or FastAPI apps
›Extract parameter schemas from function signatures
›Build interactive API playground pages

README

API Docs Generator Pack

Generate API documentation from code with examples, schemas, and formatted output. Supports FastAPI, Flask, and Django REST Framework with Markdown, HTML, and OpenAPI output.

Quick Start

agentnode install api-docs-generator-pack

from api_docs_generator_pack.tool import run

result = run(
    capability="generate_api_docs",
    params={"source_path": "./src/main.py", "framework": "fastapi"}
)
print(result["output_path"])

Usage

Markdown documentation with examples

result = run(
    capability="generate_api_docs",
    params={
        "source_path": "./src/main.py",
        "framework": "fastapi",
        "output_format": "markdown",
        "include_examples": True
    }
)

OpenAPI YAML spec

result = run(
    capability="generate_api_docs",
    params={
        "source_path": "./app/routes/",
        "framework": "flask",
        "output_format": "openapi-yaml",
        "title": "Payment Gateway API",
        "version": "3.0.1"
    }
)

HTML reference with interactive playground

result = run(
    capability="generate_api_docs",
    params={
        "source_path": "./views/",
        "framework": "django-rest",
        "output_format": "html",
        "playground": True
    }
)

API Reference

Capability	Description
`generate_api_docs`	Parse source code and generate API documentation

Parameters: source_path (required), framework, output_format (markdown, html, openapi-yaml, openapi-json), title, version, include_examples, playground.

Returns: output_path, endpoints_found, endpoints, schemas_count, paths_count.

Requirements

No environment variables required. The source code must be accessible in the workspace.

License

MIT

Version History

v1.0.0latestverified

3/16/2026

Capabilities

api_documentationgenerate_api_docstool

Permissions

This package declares the following access levels. Review before installing.

Networknone

Filesystemworkspace_read

Code Executionnone

Data Accessinput_only

User Approvalnever

bash

agentnode install api-docs-generator-pack

Files (3)

License

MIT

Stats

Downloads0

Installs0

Versionv1.0.0

Published3/16/2026

Channelstable

Typetoolpack

Entrypointapi_docs_generator_pack.tool

Compatibility

Frameworks

langchaincrewaigeneric

Runtime

python

Python Version

>=3.10

Trust & Security

Publisher★Trusted

SignatureNone

ProvenanceNone

Security Issues0

Publisher

AgentNode

@agentnode

Report an issue with this package