docurift
DocuRift is an intelligent API documentation generator that automatically analyzes your API traffic and generates comprehensive documentation in multiple formats. It works as a proxy server that captures API requests and responses, then generates OpenAPI and Postman collection documentation.
File Explorer
Download Latest Version (.zip)- go-tests.yml
- release.yml
- DocuRift.png
- main.go
- analyzer.md
- configuration.md
- persisitance.md
- shop.go
- shop_test.go
- main.5b8d67ab.js
- main.5b8d67ab.js.LICENSE.txt
- main.5b8d67ab.js.map
- main.8b11c3f9.js
- main.8b11c3f9.js.LICENSE.txt
- main.8b11c3f9.js.map
- asset-manifest.json
- index.html
- analyzer.go
- analyzer_test.go
- openapi.go
- openapi_test.go
- postman.go
- server.go
- swagger_ui.go
- ui_embed.go
- config.go
- config_test.go
- config.yaml
- docker-compose.yml
- Dockerfile
- Dockerfile.docurift
- Dockerfile.shop
- expected_openapi.json
- run_tests.sh
- .dockerignore
- .gitignore
- .goreleaser.yml
- config-docker.yaml
- config.yaml
- Dockerfile
- go.mod
- go.sum
- LICENSE
- Makefile
- README.md
# Installation Guide
git clone https://github.com/tienanr/docurift
Downloads the entire project code from GitHub to your computer.
cd docurift
Moves into the project folder you just downloaded.
2. Official Install Script
Easy Recommended- Go Go is required to use go install.
go install github.com/tienanr/docurift/cmd/docurift@latest
Downloads and installs the specified version directly β no need to clone the repo yourself.
Pulled directly from this repo's README.
3. Docker
Easy- 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 pull ghcr.io/tienanr/docurift:latest
Type this command into your terminal and run it.
docker run -p 9876:9876 -p 9877:9877 -v $(pwd)/config.yaml:/etc/docurift/config.yaml ghcr.io/tienanr/docurift:latest
Runs the built image as an actual container.
backend-url: http://host.docker.internal:8080
Type this command into your terminal and run it.
docker run -p 9876:9876 -p 9877:9877 -v $(pwd)/config-docker.yaml:/etc/docurift/config.yaml ghcr.io/tienanr/docurift:latest
Runs the built image as an actual container.
Pulled directly from this repo's README.
4. Go
Mediumgo install github.com/tienanr/docurift/cmd/docurift@latest
Downloads and installs the specified version directly β no need to clone the repo yourself.
go run shop.go &
Runs the Go program directly without a separate build step.
Pulled directly from this repo's README.
5. Make
Medium- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.