Repolode
swagger-api

swagger-api/swagger-codegen

OpenAPI/Swagger 정의에서 API 클라이언트 SDK, 서버 스텁, HTML 문서를 생성하는 CLI 도구입니다.

스타
17,793
포크
5,948
열린 이슈
3,442
마지막 커밋
어제

어떤 프로젝트인가요?

Swagger Codegen은 OpenAPI 또는 Swagger 명세를 읽어 API 클라이언트 라이브러리, 서버 스텁, API 문서를 생성하는 템플릿 기반 코드 생성기입니다. 팀에서 사용하는 각 언어마다 요청 모델과 엔드포인트 래퍼를 직접 작성할 필요가 없습니다.

Java, C#, Go, Python, TypeScript, PHP, Swift, Kotlin, Rust 등 다양한 언어용 클라이언트와 Spring, ASP.NET Core, Flask, Rails 등의 프레임워크용 서버 스텁을 지원합니다. 문서는 정적 HTML 파일이나 동적 단일 페이지 HTML 앱으로 생성할 수 있습니다. CLI JAR, Docker, 또는 Maven과 Gradle 워크플로 통합을 통해 생성 작업을 실행합니다.

프로젝트는 Maven group ID가 서로 다른 2.X와 3.X 버전 계열로 나뉘며, OpenAPI 3.0은 3.X 계열에서만 지원합니다. 템플릿을 커스터마이징해 출력물을 조정하거나 자체 타깃을 추가할 수 있습니다.

핵심 기능

  • 01OpenAPI 또는 Swagger 명세에서 수십 가지 언어와 프레임워크용 API 클라이언트를 생성합니다.
  • 02Spring, ASP.NET Core, Flask, Rails 등의 프레임워크용 서버 스텁을 생성합니다.
  • 03정적 또는 동적 HTML API 문서를 생성합니다.
  • 04템플릿을 커스터마이징해 출력물을 변경하거나 새 생성기를 추가할 수 있습니다.
  • 05CLI, Docker, 또는 Maven과 Gradle 워크플로를 통해 실행할 수 있습니다.

활용 사례

  • 여러 클라이언트 팀이 사용하는 내부 REST API용 타입 지정 SDK를 생성합니다.
  • 명세 우선 API 설계를 바탕으로 서버 스텁의 기본 구조를 만듭니다.
  • OpenAPI 파일에서 HTML 레퍼런스 문서를 생성해 게시합니다.
  • 샘플 petstore 클라이언트를 만들어 생성된 코드의 구조를 살펴봅니다.

빠른 시작

  1. 1

    저장소를 클론합니다

    git clone https://github.com/swagger-api/swagger-codegen
  2. 2

    프로젝트 디렉터리로 이동합니다

    cd swagger-codegen
  3. 3

    Maven으로 프로젝트를 빌드합니다

    mvn clean package
  4. 4

    Petstore 사양에서 PHP 클라이언트를 생성합니다

    java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i https://petstore.swagger.io/v2/swagger.json -l php -o /var/tmp/php_api_client

사용 전 알아둘 점

  • Java와 Maven을 사용해 소스에서 빌드해야 하므로 설정 작업이 추가됩니다.
  • 버전 2.X와 3.X는 서로 다른 group ID로 별도 관리되므로 필요한 버전을 확인하세요.

토픽

자주 묻는 질문

swagger-codegen은(는) 무엇인가요?
OpenAPI/Swagger 정의에서 API 클라이언트 SDK, 서버 스텁, HTML 문서를 생성하는 CLI 도구입니다. Swagger Codegen은 OpenAPI 또는 Swagger 명세를 읽어 API 클라이언트 라이브러리, 서버 스텁, API 문서를 생성하는 템플릿 기반 코드 생성기입니다. 팀에서 사용하는 각 언어마다 요청 모델과 엔드포인트 래퍼를 직접 작성할 필요가 없습니다.
swagger-codegen은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
swagger-codegen은(는) Apache-2.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
swagger-codegen은(는) 아직 유지보수되고 있나요?
활발히 유지보수 중. swagger-codegen의 마지막 커밋은 2026년 10월 22일입니다.
swagger-codegen은(는) 어디에 사용할 수 있나요?
여러 클라이언트 팀이 사용하는 내부 REST API용 타입 지정 SDK를 생성합니다. 명세 우선 API 설계를 바탕으로 서버 스텁의 기본 구조를 만듭니다. OpenAPI 파일에서 HTML 레퍼런스 문서를 생성해 게시합니다. 샘플 petstore 클라이언트를 만들어 생성된 코드의 구조를 살펴봅니다.
swagger-codegen는 어떻게 설치하나요?
저장소를 클론합니다: git clone https://github.com/swagger-api/swagger-codegen 프로젝트 디렉터리로 이동합니다: cd swagger-codegen Maven으로 프로젝트를 빌드합니다: mvn clean package Petstore 사양에서 PHP 클라이언트를 생성합니다: java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i https://petstore.swagger.io/v2/swagger.json -l php -o /var/tmp/php_api_client
swagger-codegen은(는) 어디서 받을 수 있나요?
소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/swagger-api/swagger-codegen

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.

관련 프로젝트