프로젝트 소개

Swagger Codegen은 OpenAPI 또는 Swagger API 설명을 클라이언트 라이브러리, 서버 스텁, API 문서 및 지원 아티팩트로 변환합니다. 2.x 및 3.x 라인은 독립적으로 유지 관리되며 서로 다른 Maven 그룹 ID를 사용합니다. OpenAPI 3.0.x 지원은 3.x에서만 가능합니다. README에는 사양 1.0~3.0에 대한 현재 3.x 안정 릴리스로 3.0.71이, 사양 1.0~2.0에 대한 현재 2.x 안정 릴리스로 2.4.46이 나열되어 있습니다. 지원되는 출력에는 Java, Python, JavaScript/TypeScript, Go, C#, PHP, Ruby, Swift, Kotlin, Rust 등 다양한 언어용 API 클라이언트, Spring, JAX-RS, ASP.NET Core, Go, Flask, Node.js, Rails, Scala 프레임워크를 포함한 프레임워크용 서버 스텁, HTML, 동적 HTML 및 Confluence Wiki 문서가 포함됩니다. 또한 Apache2 구성 및 JMeter 관련 출력을 생성할 수도 있습니다. 주요 인터페이스는 Java CLI입니다. 일반적인 명령은 입력 사양, 대상 언어 또는 프레임워크, 출력 디렉터리를 사용합니다. CLI는 일반 생성 도움말과 언어별 구성 도움말을 제공하며, 구성 파일, 사용자 정의 템플릿, 유형 매핑, 가져오기 매핑 및 선택적 생성을 통해 생성된 출력을 맞춤 설정할 수 있습니다. 동적 HTML 출력은 포함된 Node.js 예제를 통해 제공될 수 있으며, 정적 HTML 출력은 간단한 독립형 HTML 파일을 생성합니다. 이 프로젝트는 Maven으로 빌드하고, Docker를 사용하고, Maven, Gradle 및 GitHub 기반 워크플로우에 생성을 통합하는 방법을 문서화합니다. 자체 인스턴스를 실행하고 싶지 않은 사용자를 위해 온라인 생성기도 참조됩니다. 사양 유효성 검사를 위해 README는 온라인 Swagger 유효성 검사기와 로컬 유효성 검사를 위한 Spectral을 안내합니다. 보안 참고 사항에서는 코드 주입이 발생할 수 있으므로 신뢰할 수 없는 출처의 사양은 생성 전에 검토해야 한다고 경고합니다. 프로젝트의 템플릿은 저장소 라이선스의 적용을 받지만, 생성된 코드는 있는 그대로(AS IS) 사용자 소유이며 상위 프로젝트 라이선스의 적용을 받지 않습니다.