Welcome to SwaggBot Wiki

Your complete guide to transforming Swagger docs into conversational API interfaces. Choose your path: Web UI for teams, MCP for power users, or API for integrations.

5-Minute Quick Start

Requirements: Node.js 18+, Docker (recommended), and an LLM API key (Moonshot, OpenAI, Anthropic, or Ollama)

1

Clone the Repository

Get the latest version from GitHub

git clone https://github.com/TechBloom-ai/swaggbot.git
2

Install Dependencies

Navigate to the project and install packages

cd swaggbot && pnpm install
3

Configure Environment

Copy the example environment file and add your LLM API key

cp .env.example .env
4

Configure Security Keys

Generate required security keys

export SESSION_SECRET=$(openssl rand -base64 32)
5

Start with Docker (Recommended)

Run the application using Docker Compose

docker-compose up -d swaggbot-web
6

Open Your Browser

Visit localhost:3003 and start chatting with your API

http://localhost:3003

Three Ways to Use SwaggBot

Web UI

Perfect for teams and non-technical users. Access through any browser with a beautiful chat interface.

Learn more

MCP Client

For power users. Connect SwaggBot to Claude, Cursor, or Windsurf for agentic API interactions.

Learn more

Direct API

For developers. Integrate SwaggBot directly into your applications using RESTful endpoints.

Learn more