このプロジェクトについて

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(現状有姿)であり、ユーザーが所有し、親プロジェクトのライセンスの対象ではないことを意図しています。