apimesh
Auto-generate OpenAPI 3.0 specs + interactive HTML API UI from your codebase — in seconds.
File Explorer
Download Latest Version (.zip)- docker-build.yml
- README.md
- __init__.py
- build_evidence.py
- discovery.py
- lane.py
- loader.py
- reconcile.py
- spring_prover.py
- contract-lane.md
- definition_swagger_generator.py
- find_api_definition_files.py
- generate_file_information.py
- identify_api_functions.py
- run_swagger_generation.py
- __init__.py
- definition_swagger_generator.py
- find_api_definition_files.py
- generate_file_information.py
- identify_api_functions.py
- run_swagger_generation.py
- constants.py
- definition_swagger_generator.py
- find_api_definition_files.py
- generate_file_information.py
- identify_api_functions.py
- run_swagger_generation.py
- definition_swagger_generator.py
- django_urlconf.py
- find_api_definition_files.py
- generate_file_information.py
- identify_api_functions.py
- run_swagger_generation.py
- __init__.py
- definition_swagger_generator.py
- find_api_definition_files.py
- generate_file_information.py
- identify_api_functions.py
- run_swagger_generation.py
- AlertsController.java
- alerts.yaml
- expected.json
- pom.xml
- openapi.yaml
- app.py
- expected.json
- BillingClient.java
- expected.json
- application.yml
- charges.yaml
- expected.json
- gen.go
- partner.yaml
- expected.json
- openapi.yaml
- api_gen.go
- gen.go
- server.go
- expected.json
- api.yaml
- expected.json
- gen.go
- oapi-codegen.yaml
- OrdersApiDelegateImpl.java
- orders.yaml
- expected.json
- pom.xml
- HealthController.java
- health.yaml
- expected.json
- pom.xml
- PetsController.java
- pets.yaml
- BUILD.bazel
- openapi_defs.bzl
- expected.json
- openapi.yaml
- UsersController.java
- expected.json
- conftest.py
- test_contract_lane_build_evidence.py
- test_contract_lane_fixtures.py
- test_contract_lane_inventory.py
- test_contract_lane_pipeline.py
- test_contract_lane_reconcile.py
- test_contract_lane_spring_prover.py
- test_core_fixes.py
- test_golang_pipeline_fixes.py
- test_java_pipeline_fixes.py
- test_nodejs_pipeline_fixes.py
- test_pipeline_common.py
- test_python_pipeline_fixes.py
- test_rails_pipeline_fixes.py
- test_tree_sitter_byte_offsets.py
- .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 RecommendedPrerequisites
- 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
EasyPrerequisites
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
Was this content helpful?
(0 ratings)