apimesh

(★ 327)

Auto-generate OpenAPI 3.0 specs + interactive HTML API UI from your codebase — in seconds.

  • .dockerignore
  • .gitignore
  • apimesh-docs.html
  • bootstrap_mcp_runner.sh
  • build-docker.sh
  • CODE_OF_CONDUCT.md
  • config.py
  • config.yml
  • CONTRIBUTING.md
  • docker-entrypoint.sh
  • Dockerfile
  • file_scanner.py
  • framework_identifier.py
  • img.png
  • LICENSE
  • llm_client.py
  • pipeline_common.py
  • prompts.py
  • README.md
  • requirements-dev.txt
  • requirements.txt
  • run.sh
  • security.md
  • swagger_generation_cli.py
  • swagger_generator.py
  • swagger_mcp.py
  • telemetry_posthog.py
  • user_config.py
  • utils.py

# Installation Guide

1. Get the code
git clone https://github.com/qodex-ai/apimesh

Downloads the entire project code from GitHub to your computer.

cd apimesh

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run --pull always -it --rm -v $(pwd):/workspace \

Runs the built image as an actual container.

docker run --pull always --rm -v $(pwd):/workspace \

Runs the built image as an actual container.

Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

If it runs without errors and prints output in the terminal, it worked.
// repository documentation