Apimatic 0.1.2

Universal API documentation generator

Apimatic 🚀

A tool to automatically generate beautiful and comprehensive API documentation (Markdown/OpenAPI) from your source code.
Supports Flask, FastAPI, and more frameworks with optional AI-powered enhancements via Ollama.

---

📦 Installation

pip install apimatic

Upgrade to the latest version:

pip install --upgrade apimatic

---

⚡ Usage

Apimatic [-h] [--src SRC] [--framework [FRAMEWORK ...]] [--format {markdown,openapi}] 
         [--output OUTPUT] [--use-ollama] [--model MODEL]

---

🔑 Options

Option	Description
-h, --help	Show help message and exit
--src SRC	Root directory of the project to scan (Default: current directory)
--framework [FRAMEWORK ...]	Force a specific framework (flask, fastapi, etc.). If omitted, auto-detected
--format {markdown,openapi}	Output format (markdown or openapi) – Default: markdown
--output OUTPUT	Path for the generated output file (Default: API_Docs.md or openapi.yaml)
--use-ollama	Enhance generated docs with descriptions from a local Ollama model
--model MODEL	Ollama model for enhancement (e.g., llama3:instruct). Requires --use-ollama

---

📝 Examples

Generate Markdown docs from the current project:

Apimatic --src . --format markdown --output API_Docs.md

Generate OpenAPI spec:

Apimatic --src . --format openapi --output openapi.yaml

Force framework detection (Flask):

Apimatic --src ./my_flask_app --framework flask

Enhance documentation with AI (Ollama model):

Apimatic --src . --use-ollama --model llama3:instruct

---

🤝 Contributing

Contributions are welcome! Please fork the repo, make your changes, and submit a PR.

---

📄 License

This project is licensed under the MIT License.