ApiMesh 🚀

Open-Source OpenAPI Generator – Automatically scan your codebase, generate accurate OpenAPI 3.0 specs, and render a beautiful interactive HTML API UI for instant exploration.

From code to live API docs in seconds — no manual writing, no drift, no hassle.

---

Overview

ApiMesh is the AI-powered open-source tool that:

• Scans your codebase automatically.
• Discovers all REST API endpoints, parameters, auth, and schemas.
• Generates a valid swagger.json (OpenAPI 3.0).
• Renders apimesh-docs.html — a fully interactive API UI powered by Swagger UI.

Open the HTML file in any browser. No server. No setup. Just click and explore.

---

✨ Key Features

Feature	Benefit
🔍 Smart Code Discovery	Finds endpoints across frameworks — no annotations needed
📄 OpenAPI 3.0 Spec	swagger.json ready for CI/CD, gateways, and tools
🌐 Interactive HTML UI	apimesh-docs.html — instant API playground with try-it-out
🌍 Multi-Language	Python, Node.js, Ruby on Rails, Go, and more
⚡ Zero Config Start	One command → full docs + UI
📱 Self-Contained HTML	Share via email, GitHub, or CDN — works offline

---

🧠 How It Works

A precise, AI-augmented pipeline ensures reliable, up-to-date docs:

1. Scan Repo → FileScanner walks your code (respects .gitignore + config.yml)
2. Detect Framework → Heuristics + LLM identify Express, FastAPI, Rails, etc.
3. Harvest Endpoints → Native parsers + LLM extract routes, methods, schemas
4. Enrich Context → Vector embeddings pull auth, models, examples per endpoint
5. Generate Spec → swagger.json built with OpenAI precision
6. Render UI → apimesh-docs.html embedded with Swagger UI — fully interactive
7. Optional Sync → Push to Qodex.ai for auto-tests and security scans

---

🌐 Supported Languages & Frameworks

Language	Frameworks	Detection Method
Python	Django, Flask, FastAPI, DRF	Route files + decorators
Node.js / TS	Express, NestJS	app.get, Router, decorators
Ruby on Rails	Rails	routes.rb + controllers
Go, Java, etc.	Any REST	LLM fallback + patterns

Add custom patterns in config.yml — PRs welcome!

---

📂 Output Files

File	Location	Purpose
swagger.json	apimesh/swagger.json	OpenAPI 3.0 spec
apimesh-docs.html	apimesh/apimesh-docs.html	Interactive API UI — open in browser
config.yml	Repo root	Customize scan, host, ignores

Deploy apimesh-docs.html to GitHub Pages, Netlify, or Vercel in 1 click.

---

🚀 Quick Start (30 Seconds)

Option 1: docker (Fastest)

# Navigate to your repository
cd /path/to/your/repo

# Run interactively - will prompt for any missing inputs
docker run -it --rm -v $(pwd):/workspace qodexai/apimesh:latest

Option 2: Using MCP

Download the MCP server file

wget https://github.com/qodex-ai/apimesh/blob/main/swagger_mcp.py -O swagger_mcp.py

Add this to your MCP settings

{
  "mcpServers": {
    "apimesh": {
      "command": "uv",
      "args": ["run", "/path/to/swagger_mcp/swagger_mcp.py"]
    }
  }
}

Replace /path/to/swagger_mcp/swagger_mcp.py with the actual file path.

Option 3: Curl

curl -sSL https://raw.githubusercontent.com/qodex-ai/apimesh/refs/heads/main/bootstrap_swagger_generator.sh -o swagger_bootstrap.sh \
  && chmod +x swagger_bootstrap.sh \
  && ./swagger_bootstrap.sh

---

🤝 Contributing

Contributions are welcome!

Open an issue for bugs, feature requests, or improvements.

Submit PRs to enhance language/framework coverage.

Help us make API documentation automatic and effortless 🚀