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.
파일 탐색기
최종 버전 다운로드 (.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
# 설치 가이드
1. 코드 내려받기
git clone https://github.com/tienanr/docurift
깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.
cd docurift
방금 내려받은 프로젝트 폴더 안으로 이동합니다.
2. 공식 설치 스크립트
쉬움 추천사전 준비물
- Go go install 명령어를 쓰려면 Go가 필요합니다.
go install github.com/tienanr/docurift/cmd/docurift@latest
지정된 버전을 바로 다운로드해서 설치합니다. 레포를 직접 클론할 필요가 없습니다.
설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
3. Docker
쉬움사전 준비물
- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker pull ghcr.io/tienanr/docurift:latest
이 명령어를 터미널에 그대로 입력해 실행하세요.
docker run -p 9876:9876 -p 9877:9877 -v $(pwd)/config.yaml:/etc/docurift/config.yaml ghcr.io/tienanr/docurift:latest
빌드된 이미지를 실제 컨테이너로 실행합니다.
backend-url: http://host.docker.internal:8080
이 명령어를 터미널에 그대로 입력해 실행하세요.
docker run -p 9876:9876 -p 9877:9877 -v $(pwd)/config-docker.yaml:/etc/docurift/config.yaml ghcr.io/tienanr/docurift:latest
빌드된 이미지를 실제 컨테이너로 실행합니다.
터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
4. Go
보통go install github.com/tienanr/docurift/cmd/docurift@latest
지정된 버전을 바로 다운로드해서 설치합니다. 레포를 직접 클론할 필요가 없습니다.
go run shop.go &
따로 빌드하지 않고 바로 Go 프로그램을 실행합니다.
빌드가 에러 없이 끝나면 성공입니다. go run . 을 썼다면 터미널 출력을 확인하세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
5. Make
보통사전 준비물
- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.
make
생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.
에러 없이 끝나면 성공입니다. 생성된 실행 파일을 직접 실행해보세요.
// repository documentation
Was this content helpful?
(0 ratings)