openapi-json-schema-generator

(★ 177)

OpenAPI JSON Schema Generator allows auto-generation of API client libraries with a focus on JSON schema given an OpenAPI document

파일 수가 많아 일부만 표시됩니다. 전체 파일은 위 다운로드 버튼으로 확인해 주세요.

  • .dockerignore
  • .gitattributes
  • .gitignore
  • .gitmodules
  • Dockerfile
  • LICENSE
  • pom.xml
  • README.md

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/openapi-json-schema-tools/openapi-json-schema-generator

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd openapi-json-schema-generator

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker run --rm -v "${PWD}:/local" openapijsonschematools/openapi-json-schema-generator-cli generate \

빌드된 이미지를 실제 컨테이너로 실행합니다.

./bin/run-in-docker.sh mvn package

Maven으로 의존성 설치와 빌드를 진행합니다.

./bin/run-in-docker.sh help # Executes 'help' command for openapi-json-schema-generator-cli

이 명령어를 터미널에 그대로 입력해 실행하세요.

./bin/run-in-docker.sh list # Executes 'list' command for openapi-json-schema-generator-cli

이 명령어를 터미널에 그대로 입력해 실행하세요.

./bin/run-in-docker.sh /gen/bin/python-petstore.sh # Builds the Python client

파이썬 스크립트(또는 모듈)를 실행합니다.

터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Maven (Java)

보통
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • JDK (Java) Java 프로젝트를 빌드/실행하려면 필요합니다.
  • Maven mvn 명령어를 쓰기 위한 빌드 도구입니다.
mvn clean install

Maven으로 의존성 설치와 빌드를 진행합니다.

mvn -Pstatic-analysis clean install

Maven으로 의존성 설치와 빌드를 진행합니다.

./bin/run-in-docker.sh mvn package

Maven으로 의존성 설치와 빌드를 진행합니다.

./run-in-docker.sh mvn clean install -U

Maven으로 의존성 설치와 빌드를 진행합니다.

mvn clean package

Maven으로 의존성 설치와 빌드를 진행합니다.

BUILD SUCCESS 메시지가 뜨면 성공입니다. target/ 폴더에 결과물이 생성됩니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation