openapi-changes
The world's most powerful OpenAPI breaking changes detector. Discover what changed between two OpenAPI specs, or a single spec over time. Supports OpenAPI 3.2, 3.1 and 3.0
파일 탐색기
최종 버전 다운로드 (.zip)- change-list.png
- change-report.png
- console.gif
- explorer-deletion.png
- file-diff.png
- focus-diff.png
- roger-mode-explorer.png
- roger-mode-items.png
- summary.gif
- tektronix.png
- timeline-overview.png
- timline-explorer.png
- ui.gif
- console.tape
- summary.tape
- build.yaml
- publish.yaml
- tag.yaml
- openapi-changes.js
- spec_left.yaml
- spec_right.yaml
- test-config.yaml
- command_surface_test.go
- common.go
- common_test.go
- config.go
- config_test.go
- console.go
- console_test.go
- engine.go
- engine_test.go
- flag_surface_test.go
- flatten_report.go
- flatten_report_test.go
- html_report.go
- html_report_test.go
- left_right_sources.go
- loaders.go
- loaders_test.go
- markdown_report.go
- markdown_report_test.go
- paths.go
- paths_test.go
- petstore_regression_test.go
- report.go
- report_common.go
- report_test.go
- root.go
- root_test.go
- summary.go
- summary_test.go
- test_helpers_test.go
- version.go
- version_test.go
- windows_subprocess_test.go
- github.go
- github_test.go
- options.go
- read_local.go
- read_local_test.go
- revision_documents.go
- revision_fs.go
- revision_fs_test.go
- header.gohtml
- report.gohtml
- bundle-lite.js
- bundle.css
- bundle.js
- report-shell-base.ts
- report-shell-lite.ts
- report-shell.ts
- report.css.ts
- elk-layout-worker-inline.test.ts
- elk-layout-worker-inline.ts
- icon-registry.ts
- main-lite.ts
- main.ts
- fixtures.ts
- report-shell-data-loading.test.ts
- report-shell-render.test.ts
- report-shell-state.test.ts
- setup.ts
- index.html
- package-lock.json
- package.json
- tsconfig.json
- vite.config.ts
- vitest.config.ts
- generator.go
- generator_test.go
- config.go
- counts.go
- counts_test.go
- scope_detection.go
- scope_detection_test.go
- gitrepo.go
- commit.go
- progress.go
- report.go
- config.js
- postinstall.js
- invalid-config.yaml
- partial-config.yaml
- valid-config.yaml
- petstorev3-original.json
- petstorev3.json
- prepare-demo-fixture.sh
- render-demos.sh
- block_range.go
- block_range_test.go
- cache.go
- cache_test.go
- code_modal.go
- code_modal_test.go
- diff.go
- diff_test.go
- glamour_style.go
- highlight.go
- highlight_test.go
- keys.go
- model.go
- model_test.go
- report_modal.go
- report_modal_test.go
- styles.go
- tree.go
- tree_test.go
- tree_utils_test.go
- .gitignore
- .goreleaser.yaml
- AGENTS.md
- Dockerfile
- go.mod
- go.sum
- LICENSE
- Makefile
- openapi-changes-logo.webp
- openapi-changes.go
- package.json
- README.md
# 설치 가이드
1. 코드 내려받기
git clone https://github.com/pb33f/openapi-changes
깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.
cd openapi-changes
방금 내려받은 프로젝트 폴더 안으로 이동합니다.
2. 공식 설치 스크립트
쉬움 추천brew install pb33f/taps/openapi-changes
Homebrew로 이미 빌드된 패키지를 바로 설치합니다. 소스 빌드가 필요 없습니다.
npm i -g @pb33f/openapi-changes
npm 레지스트리에 배포된 패키지를 전역으로 설치합니다. 소스 클론이 필요 없습니다.
curl -fsSL https://pb33f.io/openapi-changes/install.sh | sh
공식 설치 스크립트를 다운로드해서 바로 실행합니다. 이 한 줄로 필요한 게 자동으로 설치됩니다.
설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
3. Docker
쉬움사전 준비물
- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker pull pb33f/openapi-changes
이 명령어를 터미널에 그대로 입력해 실행하세요.
docker run --rm -v $PWD:/work:rw pb33f/openapi-changes summary . sample-specs/petstorev3.json
빌드된 이미지를 실제 컨테이너로 실행합니다.
docker run --rm -it -v $PWD:/work:rw pb33f/openapi-changes console . path/to/openapi.yaml
빌드된 이미지를 실제 컨테이너로 실행합니다.
터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
4. Node.js
쉬움사전 준비물
npm i -g @pb33f/openapi-changes
npm 레지스트리에 배포된 패키지를 전역으로 설치합니다. 소스 클론이 필요 없습니다.
yarn global add @pb33f/openapi-changes
이 명령어를 터미널에 그대로 입력해 실행하세요.
명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
5. Go
보통go build -o bin/openapi-changes .
Go 프로그램을 컴파일해 실행 파일을 만듭니다.
빌드가 에러 없이 끝나면 성공입니다. go run . 을 썼다면 터미널 출력을 확인하세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
6. Make
보통사전 준비물
- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.
make
생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.
에러 없이 끝나면 성공입니다. 생성된 실행 파일을 직접 실행해보세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
// repository documentation
Was this content helpful?
(0 ratings)