Apimatic 🚀

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

📦 Installation

# Run this in your global environment
pip install Apimatic

Upgrade to the latest version:

pip install --upgrade Apimatic

⚡ Usage

Apimatic now uses commands to separate actions.

1. Generate Documentation:

apimatic generate [OPTIONS]

2. Configure API Keys:

apimatic config [OPTIONS]

🔑 Configuration

To use AI enhancements from providers like OpenAI, Google Gemini, or Groq, you must set an API key.

# Set your OpenAI API key
apimatic config --set-openai-key YOUR_API_KEY

# Set your Google Gemini API key
apimatic config --set-gemini-key YOUR_API_KEY

# Set your Groq API key
apimatic config --set-groq-key YOUR_API_KEY

The key will be stored securely in your home directory.

⚙️ Generation Options

📝 Examples

Basic Generation:

# Generate Markdown docs from the current project
apimatic generate --src . --output API_Docs.md

Force Framework:

# Force detection for a Flask app
apimatic generate --src ./my_flask_app --framework flask

AI-Enhanced Documentation:

First, set your key:

apimatic config --set-openai-key sk-xxxxxxxx

Then, generate with enhancement:

# Use OpenAI's gpt-4o-mini model
apimatic generate --src . --use-openai --openai-model gpt-4o-mini

# Use Google Gemini
apimatic generate --src . --use-google-gemini

# Use Groq's fast Mixtral model
apimatic generate --src . --use-groq

# Use a local Ollama model
apimatic generate --src . --use-ollama --ollama-model phi3:mini

🤖 Recommended AI Models

🤝 Contributing

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

📄 License

This project is licensed under the MIT License.