swagger-codegen

(★ 17,779)

swagger-codegen은 OpenAPI / Swagger 정의를 파싱하여 다양한 언어로 문서, API 클라이언트 및 서버 스텁을 생성하는 템플릿 기반 엔진을 포함하고 있습니다.

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

  • .dockerignore
  • .gitignore
  • .whitesource
  • appveyor.yml
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • docker-entrypoint.sh
  • Dockerfile
  • eclipse-formatter.xml
  • google_checkstyle.xml
  • LICENSE
  • README.md
  • Vagrantfile

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/swagger-api/swagger-codegen

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

cd swagger-codegen

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

2. Docker

쉬움 추천
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker build -t swagger-codegen .

Dockerfile을 기반으로 실행 가능한 이미지를 빌드합니다.

docker run -p 8080:80 swagger-codegen

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

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

3. Maven (Java)

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

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

mvn package

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

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

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

4. PHP (Composer)

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • PHP PHP 실행 환경이 필요합니다.
  • Composer PHP 라이브러리 설치를 위한 패키지 매니저입니다.
⚠️ 이 프로젝트는 규모가 큰 저장소라, 이 방법이 실제 핵심 제품이 아니라 내부 하위 패키지를 가리키는 것일 수 있습니다. README 전체를 함께 확인해보세요.
cd modules/swagger-codegen/src/main/resources/php-silex

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

composer install

composer.json에 명시된 PHP 라이브러리를 설치합니다.

php -S localhost:8000 같은 내장 서버로 실행한 뒤 브라우저에서 http://localhost:8000 으로 접속해보세요.

5. Ruby

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Ruby bundle 명령어를 쓰려면 Ruby가 필요합니다.
⚠️ 이 프로젝트는 규모가 큰 저장소라, 이 방법이 실제 핵심 제품이 아니라 내부 하위 패키지를 가리키는 것일 수 있습니다. README 전체를 함께 확인해보세요.
cd modules/swagger-codegen/src/main/resources/rails5

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

bundle install

Gemfile에 명시된 루비 라이브러리를 설치합니다.

bundle install이 에러 없이 끝나면 README에 안내된 실행 명령어(예: rails server)로 마저 실행해보세요.
// repository documentation