Nswag C#（開発者向けの動作方法）

How to Use NSwag in C

1. Swagger UI を使用して RESTful Web API を作成します。
2. C# コンソールアプリケーションを作成します。
3. NSwag ライブラリをインストールします。
4. 名前空間をインポートし、オブジェクトを作成します。
5. Swagger JSON を C# コードに変換します。
6. コードを実行し、結果を表示します。

NSwag の理解

NSwag は、ASP.NET Web API、ASP.NET Core、または他の .NET Frameworkを使用して構築された API のために Swagger 仕様、すなわち OpenAPI ドキュメントを作成するプロセスを容易にするために作成された .NET の Swagger ツールチェーンです。

NSwag の始め方

NSwag C# の例

以下は、NSwag を使用して C# クライアント コードを生成する方法を示すコード例です。

using NSwag.CodeGeneration.CSharp;
using NSwag;
using System.Reflection;
using System.CodeDom.Compiler;
using Microsoft.CodeAnalysis;
using System.Net.Http;
using System.IO;
using System.Collections.Generic;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using (var wclient = new System.Net.WebClient())
        {
            // Create JSON file data from the Swagger .NET Core web API
            var document = await OpenApiDocument.FromJsonAsync(wclient.DownloadString("http://localhost:5013/swagger/v1/swagger.json"));
            var settings = new CSharpClientGeneratorSettings
            {
                ClassName = "Weather",
                CSharpGeneratorSettings = { Namespace = "Demo" }
            };

            var generator = new CSharpClientGenerator(document, settings);
            var code = generator.GenerateFile();
            var assembly = CompileCode(code);
            var clientType = assembly.GetType("Demo.WeatherClient"); // Replace with your actual client class name
            using (var httpClient = new HttpClient())
            {
                var client = (IApiClient)Activator.CreateInstance(clientType, httpClient);
                var result = await client.GetWeatherForecastAsync();
                foreach (var item in result)
                {
                    Console.WriteLine($"Date: {item.Date} F: {item.TemperatureF} C: {item.TemperatureC} Summary: {item.Summary}");
                }
            }
        }
    }

    static Assembly CompileCode(string code)
    {
        using (var memoryStream = new MemoryStream())
        {
            var assemblyPath = Path.GetDirectoryName(typeof(object).Assembly.Location);
            var references = new List<MetadataReference>
            {
                MetadataReference.CreateFromFile(typeof(object).GetTypeInfo().Assembly.Location),
                MetadataReference.CreateFromFile(Path.Combine(assemblyPath, "Microsoft.AspNetCore.Mvc.dll")),
                MetadataReference.CreateFromFile(Path.Combine(assemblyPath, "System.Private.CoreLib.dll"))
            };

            var compilation = Microsoft.CodeAnalysis.CSharp.CSharpCompilation.Create("ApiClient")
                .WithOptions(new Microsoft.CodeAnalysis.CSharp.CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary))
                .AddReferences(references)
                .AddSyntaxTrees(Microsoft.CodeAnalysis.CSharp.SyntaxFactory.ParseSyntaxTree(code));

            var emitResult = compilation.Emit(memoryStream);
            if (!emitResult.Success)
            {
                Console.WriteLine("Compilation errors:");
                foreach (var diagnostic in emitResult.Diagnostics)
                {
                    Console.WriteLine(diagnostic);
                }
                return null;
            }
            memoryStream.Seek(0, SeekOrigin.Begin);
            return Assembly.Load(memoryStream.ToArray());
        }
    }

    public interface IApiClient
    {
        // Replace with your actual method name and return type
        Task<List<WeatherForecast>> GetWeatherForecastAsync();
    }

    public class WeatherForecast
    {
        public DateTime Date { get; set; }
        public int TemperatureC { get; set; }
        public int TemperatureF { get; set; }
        public string Summary { get; set; }
    }
}

using NSwag.CodeGeneration.CSharp;
using NSwag;
using System.Reflection;
using System.CodeDom.Compiler;
using Microsoft.CodeAnalysis;
using System.Net.Http;
using System.IO;
using System.Collections.Generic;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using (var wclient = new System.Net.WebClient())
        {
            // Create JSON file data from the Swagger .NET Core web API
            var document = await OpenApiDocument.FromJsonAsync(wclient.DownloadString("http://localhost:5013/swagger/v1/swagger.json"));
            var settings = new CSharpClientGeneratorSettings
            {
                ClassName = "Weather",
                CSharpGeneratorSettings = { Namespace = "Demo" }
            };

            var generator = new CSharpClientGenerator(document, settings);
            var code = generator.GenerateFile();
            var assembly = CompileCode(code);
            var clientType = assembly.GetType("Demo.WeatherClient"); // Replace with your actual client class name
            using (var httpClient = new HttpClient())
            {
                var client = (IApiClient)Activator.CreateInstance(clientType, httpClient);
                var result = await client.GetWeatherForecastAsync();
                foreach (var item in result)
                {
                    Console.WriteLine($"Date: {item.Date} F: {item.TemperatureF} C: {item.TemperatureC} Summary: {item.Summary}");
                }
            }
        }
    }

    static Assembly CompileCode(string code)
    {
        using (var memoryStream = new MemoryStream())
        {
            var assemblyPath = Path.GetDirectoryName(typeof(object).Assembly.Location);
            var references = new List<MetadataReference>
            {
                MetadataReference.CreateFromFile(typeof(object).GetTypeInfo().Assembly.Location),
                MetadataReference.CreateFromFile(Path.Combine(assemblyPath, "Microsoft.AspNetCore.Mvc.dll")),
                MetadataReference.CreateFromFile(Path.Combine(assemblyPath, "System.Private.CoreLib.dll"))
            };

            var compilation = Microsoft.CodeAnalysis.CSharp.CSharpCompilation.Create("ApiClient")
                .WithOptions(new Microsoft.CodeAnalysis.CSharp.CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary))
                .AddReferences(references)
                .AddSyntaxTrees(Microsoft.CodeAnalysis.CSharp.SyntaxFactory.ParseSyntaxTree(code));

            var emitResult = compilation.Emit(memoryStream);
            if (!emitResult.Success)
            {
                Console.WriteLine("Compilation errors:");
                foreach (var diagnostic in emitResult.Diagnostics)
                {
                    Console.WriteLine(diagnostic);
                }
                return null;
            }
            memoryStream.Seek(0, SeekOrigin.Begin);
            return Assembly.Load(memoryStream.ToArray());
        }
    }

    public interface IApiClient
    {
        // Replace with your actual method name and return type
        Task<List<WeatherForecast>> GetWeatherForecastAsync();
    }

    public class WeatherForecast
    {
        public DateTime Date { get; set; }
        public int TemperatureC { get; set; }
        public int TemperatureF { get; set; }
        public string Summary { get; set; }
    }
}

使用したい API については、Swagger 仕様の URL (swaggerUrl) を指定します。 次に、生成および実行されるクライアントコードを DLL アセンブリに定義します。 OpenApiDocument は、FromJsonAsync を使用して、指定された URL から Swagger ドキュメントを非同期的にロードするために使用されます。 生成されたクライアント コードを変更するには、コード ジェネレーターの設定を調整します (CSharpClientGeneratorSettings)。 この例では、生成されたクライアントコードのクラス名と名前空間を指定します。

ロードされた Swagger ドキュメントから、CSharpClientGenerator のインスタンスを作成し、それを使用してクライアント コードを生成します。 作成されたクライアントコードは指定された出力パスに保存されます。 手続き中に発生する可能性のある例外やエラーに対応し、関連する通知をコンソールに表示します。

NSwag の操作

NSwag と IronPDF の統合

NSwag を IronPDF と統合することで、両技術の利点を活用して API ドキュメントのワークフローが改善されます。 開発者は、NSwag を使用して Swagger 仕様を生成し、IronPDF を使用してそれらを PDF に変換することによって、オフラインでも利用可能で共有しやすい .NET Web API ドキュメントを作成できます。 統合プロセスは以下の手順で行います。

IronPDF は HTML から PDF への変換に秀でており、元のレイアウトとスタイルを正確に保存します。 これは、レポート、請求書、ドキュメントなどの Web ベースのコンテンツから PDF を作成するのに最適です。 HTML ファイル、URL、または生の HTML 文字列のサポートにより、IronPDF は高品質な PDF ドキュメントを簡単に生成します。

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}

IronPDFのインストール

• Visual Studio プロジェクトを開始します。
• "ツール">"NuGet パッケージ マネージャー">"パッケージ マネージャー コンソール"を選択します。
• コマンドプロンプトを開き、パッケージマネージャーコンソールで次のコマンドを入力します。

Install-Package IronPdf

• または、ソリューションの NuGet パッケージマネージャーを使用して IronPDF をインストールできます。
• 検索結果から IronPDF パッケージを探して選択し、インストールオプションをクリックしてください。 Visual Studio がダウンロードとインストールを代行します。

• NuGet が IronPDF パッケージとプロジェクトに必要な依存関係をインストールします。
• インストール後、IronPDF はプロジェクトで利用できるようになります。

ロジックを実装する

NSwag を利用することで、開発者はIronPDFと組み合わせて CodeGeneration.CSharp を使用することで、API ドキュメントと API を使用するためのクライアント コードをより迅速に作成できます。 統合ワークフローは以下の手順を含みます。

1.クライアント コードの生成: Swagger 仕様から C# クライアント コードを作成するには、NSwag.CodeGeneration.CSharp を使用します。 このステップでは、API エンドポイントとの通信のためのクライアントクラスとメソッドの生成が自動化されます。

2. NSwag を使用してデータを取得する: Swagger 仕様から JSON ドキュメントを生成するには、CodeGeneration.CSharp を使用します。 この段階では、リクエスト/レスポンス形式、認証方法、API クライアントエンドポイントを人間が理解できるドキュメントとして作成します。
3. JSON から PDF への変換: IronPDF を使用して、生成されたコードの結果を PDF ドキュメントに変換します。 この段階では、HTML テキストを共有および配布可能な洗練された PDF ドキュメントに変換します。
4. PDF ドキュメントの改善: ヘッダー、フッター、透かし、またはユニークなブランドなどのコンテンツを IronPDF を使用して PDF ドキュメントに追加します。 このステージでは、開発者は自身の好みに合わせて PDF ドキュメントの外観とブランディングをカスタマイズできます。

using IronPdf;
using System.Text;
using System.Collections.Generic;

StringBuilder sb = new StringBuilder();

foreach (var item in result)
{
    sb.Append($"<p>Date: {item.Date} F: {item.TemperatureF} C: {item.TemperatureC} Summary: {item.Summary}</p>");
}

var renderer = new HtmlToPdf();
var pdf = renderer.RenderHtmlAsPdf(sb.ToString());
pdf.SaveAs("output.pdf");
Console.WriteLine("PDF generated successfully!");
Console.ReadKey();

using IronPdf;
using System.Text;
using System.Collections.Generic;

StringBuilder sb = new StringBuilder();

foreach (var item in result)
{
    sb.Append($"<p>Date: {item.Date} F: {item.TemperatureF} C: {item.TemperatureC} Summary: {item.Summary}</p>");
}

var renderer = new HtmlToPdf();
var pdf = renderer.RenderHtmlAsPdf(sb.ToString());
pdf.SaveAs("output.pdf");
Console.WriteLine("PDF generated successfully!");
Console.ReadKey();

上記のコードは、結果オブジェクトから取得したデータにアクセスし、ループ内の段落にフィールド TemperatureC、および Summary を追加します。次に、PDFの出力ファイルパスを指定し、PDFが正常に生成されたことをユーザーに通知します。

上記コードの結果は以下です。

結論

CodeGeneration NSwag テクノロジーとIronPDFは連携して動作し、クライアントのコード作成と API ドキュメント作成プロセスを効率化します。 開発者は、これらのツールを C# アプリケーションに統合することで、API ドリブン ソリューションの作成をスピードアップし、API ドキュメントの作成を自動化し、プロフェッショナルな外観の PDF 出版物を生成できます。 NSwag.CodeGeneration.CSharp とIronPDF を組み合わせることで、デスクトップ、Web、クラウドベースのアプリを開発する開発者に、API を効率的に文書化し、C# でクライアント コードを作成するための完全なソリューションが提供されます。

Lite バンドルには、永久ライセンス、1 年間のソフトウェア メンテナンス、およびライブラリのアップグレードが含まれています。 IronPDF は、再配布および期間に制限のある無料のライセンスを提供しています。ユーザーは、試用期間中にウィーターマークを視認せずにソリューションを評価できます。 価格およびライセンスに関する詳細については、IronPDF のライセンス情報をご覧ください。 Iron Software の製品ライブラリに関する詳細については、Iron Software ライブラリのページに移動してください。