Api Doc Generator is a standalone, browser-based AI workflow app for Developer / API. It turns structured inputs, uploaded files, and project-specific settings into reviewable outputs using a deterministic local engine plus optional local/cloud LLM enhancement.

Core job: Code/OpenAPI/schema → publishable developer documentation.

Designed for: Domain operator, business owner, analyst, or team member who needs this workflow executed reliably.

Why use it:

• 🧩 Standalone project folder: run this project by itself without depending on a central dashboard.
• 🖥️ Elegant GUI: includes project-specific panels, structured forms, upload handling, output preview, and exports.
• 🧠 Model-flexible: choose local models for privacy or cloud models for stronger reasoning.
• 🧾 Auditable: every run is stored in SQLite with inputs, settings, result, and export history.
• 🚫 No fake live data: external systems are only used when real API keys/connectors are configured.
• 🛡️ Human review gates: sensitive legal, medical, hiring, finance, or security outputs are flagged for review.

• OpenAPI import
• endpoint grouping
• auth examples
• SDK snippets
• changelog
• error catalog
• try-it console
• version diff
• Postman/Insomnia export

• ⚡ FastAPI backend with documented JSON endpoints.
• 🎨 Responsive web UI with dark, polished SaaS-style layout.
• 📁 File upload and text extraction for common document/code formats.
• 🗂️ Job history saved locally in data/*.sqlite3.
• 🔐 Encrypted provider settings for API keys and local endpoints.
• 📤 Exports to Markdown, JSON, DOCX, and PDF when dependencies are available.
• 🔌 Provider routing for local and cloud LLMs.
• 🧪 Local test file to verify the project runs.

UX profile: Developer Workbench

Workflow layout: Code/schema/log intake → analysis → diff/tests/docs → implementation checklist

Empty state: Paste code, schema, logs, or upload source files. Real repository actions require Git/CI connectors.

• Endpoint explorer
• OpenAPI preview
• SDK snippet tabs
• Auth/error catalog
• Docs publish checklist

• Inspect
• Analyze
• Patch
• Test
• Ship

• Coverage readiness
• Risk/bug count
• Implementation clarity
• Docs completeness

• Parse endpoints
• Generate OpenAPI outline
• Build SDK examples
• Create changelog notes

These are the main fields exposed by the GUI and /api/run. Required fields are enforced before execution.

This project is not a generic prompt box. The customization controls are connected to workflow behavior, validation, output shape, and export format.

• Execution mode: Draft, Production, Audit / strict review, JSON/API output
• audience level: general, executive, technical, legal, medical, student, customer
• framework: auto detect, React, Next.js, Laravel, NestJS, .NET, Django, FastAPI, Custom
• language examples: English, Arabic, Egyptian Arabic, French, German, Spanish
• output format: Markdown, JSON, CSV, PDF, DOCX, XLSX
• language: English, Arabic, Egyptian Arabic, French, German, Spanish
• privacy mode: cloud allowed, local only, redact sensitive data

You can run the project with the local deterministic engine, or enhance the output with a configured LLM provider.

cd api-doc-generator

chmod +x run_gui.sh
./run_gui.sh

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
.\run_gui_windows.ps1

http://127.0.0.1:9102

Use this when you want full control instead of the run scripts.

cd api-doc-generator
python -m venv .venv
source .venv/bin/activate      # Windows: .venv\Scripts\activate
python -m pip install --upgrade pip
pip install -r requirements.txt
cp .env.example .env           # Windows: copy .env.example .env
uvicorn app.main:app --host 127.0.0.1 --port 9102

The project can be configured through the GUI settings screen or .env/environment variables.

1. Open the local URL.
2. Review the project purpose and workflow lanes.
3. Fill the required input fields.
4. Adjust only the project-related customization controls.
5. Upload source files when needed.
6. Choose Rule Engine for local deterministic output or select a configured LLM provider.
7. Run the workflow.
8. Review warnings, scorecards, and output sections.
9. Export the result as Markdown, JSON, DOCX, or PDF.

• Code/OpenAPI/schema
• publishable developer documentation

• api_doc
• code_inventory
• developer_review

• Endpoint inventory
• Auth notes
• Examples
• OpenAPI gaps

• Correctness
• Security risk
• Maintainability
• Test coverage
• Deployment readiness

• Markdown/HTML docs
• OpenAPI patches
• Postman collection
• SDK examples

The export system is designed for reviewable deliverables. For regulated or business-critical work, export drafts should be reviewed before sending to clients, customers, patients, employees, authorities, or production systems.

Configured integrations in this standalone folder:

• File upload
• REST API
• Export download
• Job history

• repository or source files
• CI/CD or observability connector for live system data
• human approval before modifying production systems

Important: this project does not simulate live data. If a workflow needs live Shopify, ATS, ERP, tax, customs, medical, security, market, map, analytics, or repository data, it must be connected with valid credentials and real API access. Missing connectors should produce clear setup errors rather than invented results.

• Show uncertainty and confidence
• Cite evidence from input when possible
• Human review required for legal, medical, financial, hiring, or security decisions
• Do not invent facts absent from input

Recommended operating rules:

• ✅ Use local models for private or sensitive files.
• ✅ Keep API keys out of Git.
• ✅ Review low-confidence or high-impact outputs manually.
• ✅ Keep source files and exported deliverables organized under data/.
• ❌ Do not treat AI output as legal, medical, tax, hiring, trading, or security authority without expert review.

Run the local smoke test:

python tests/test_single_project.py

Run a health check after starting the server:

curl http://127.0.0.1:9102/api/health

Expected result: the API returns ok: true and identifies this project.

curl -X POST http://127.0.0.1:9102/api/run \
  -H "Content-Type: application/json" \
  -d '{
    "inputs": {
      "work_brief": "Paste the source material or task details here"
    },
    "customization": {
      "execution_mode": "Production"
    },
    "provider": "rule_engine"
  }'

api-doc-generator/
├─ app/                         # FastAPI backend, schemas, DB, providers, exports
├─ static/                      # Browser GUI assets
├─ plugins/                     # Project plugin JSON metadata
├─ data/                        # SQLite DB, uploads, exports
├─ tests/                       # Smoke tests
├─ project_config.json          # Project-specific inputs, controls, UX, workflow
├─ PROJECT_IMPLEMENTATION.md    # Implementation details and domain notes
├─ requirements.txt             # Python dependencies
├─ run_gui.sh                   # macOS/Linux/WSL launcher
├─ run_gui_windows.ps1          # Windows PowerShell launcher
└─ README.md                    # This file

For local/private deployment, run with uvicorn behind a reverse proxy if needed. For production:

• Set AI_SUITE_SECRET_KEY.
• Use HTTPS.
• Store provider keys in environment variables or a proper secret manager.
• Restrict upload sizes and allowed file types.
• Back up the SQLite database or move job storage to a managed database.
• Add authentication before exposing beyond localhost.
• Enable logging and monitoring.

Example production-style command:

AI_SUITE_HOST=0.0.0.0 AI_SUITE_PORT=9102 uvicorn app.main:app --host 0.0.0.0 --port 9102

You can extend this project by editing:

• project_config.json for inputs, settings, output sections, UX metadata, and workflow labels.
• plugins/api-doc-generator.json for plugin metadata.
• app/domain_engine.py for deterministic business logic.
• app/llm_gateway.py for provider integrations.
• static/app.js and static/styles.css for GUI behavior and component design.
• tests/test_single_project.py for stronger project-specific tests.

Use the license included in this folder. If no explicit license is present, treat the code as private until you choose one.