JSON コンバータ
C#でAPIレスポンスをExcelレポートに変換する方法

C#でAPIレスポンスをExcelレポートに変換する方法

今日のデータ駆動型の世界では、企業はデータ交換のためにREST APIに大きく依存しています。しかし、多くの利害関係者は、分析や報告のためにこのデータをExcel形式で消費することを好みます。このガイドでは、完全なC#アプリケーションを構築する方法を示します。このアプリケーションは以下を実現します：

  1. REST APIに接続する
  2. JSONレスポンスデータを取得する
  3. データをプロフェッショナルにフォーマットされたExcelレポートに変換する
  4. チャートやテーブルを用いた視覚化を追加する

ビジネスバリュー

このソリューションは以下の点で重要な価値を提供します：

  • 手動のデータ抽出とレポート作成プロセスを自動化する
  • 手動コピーを排除することでデータの正確性を確保する
  • 一貫したレポートフォーマットを提供する
  • スケジュールされたレポート生成を可能にする

ステップバイステップの実装ガイド

ステップ1: 新しいC#アプリケーションを作成する

新しいコンソールアプリケーションを作成します：

dotnet new console -n ApiToExcelReporter
cd ApiToExcelReporter

ステップ2: 必要なパッケージをインストールする

必要なNuGetパッケージを追加します：

dotnet add package Aspose.Cells
dotnet add package Newtonsoft.Json
dotnet add package RestSharp

ステップ3: REST APIクライアントを実装する

API通信のためのサービスを作成します：

using RestSharp;
using Newtonsoft.Json;
using System;
using System.Threading.Tasks;

public class ApiService
{
    private readonly RestClient _client;
    
    public ApiService(string baseUrl)
    {
        _client = new RestClient(baseUrl);
    }
    
    public async Task<T> GetApiDataAsync<T>(string endpoint, string apiKey = null)
    {
        var request = new RestRequest(endpoint, Method.Get);
        
        // 必要に応じて認証を追加
        if (!string.IsNullOrEmpty(apiKey))
        {
            request.AddHeader("Authorization", $"Bearer {apiKey}");
        }
        
        var response = await _client.ExecuteAsync(request);
        
        if (response.IsSuccessful)
        {
            return JsonConvert.DeserializeObject<T>(response.Content);
        }
        
        throw new Exception($"API呼び出しに失敗しました: {response.ErrorMessage}");
    }
}

ステップ4: JSONレスポンスデータを処理する

JSONデータを処理するためのクラスを追加します：

using Newtonsoft.Json.Linq;
using System.Collections.Generic;

public class DataProcessor
{
    public List<Dictionary<string, object>> FlattenJsonData(string jsonData)
    {
        var results = new List<Dictionary<string, object>>();
        JToken token = JToken.Parse(jsonData);
        
        // 異なるJSON構造を処理
        if (token is JArray array)
        {
            foreach (var item in array)
            {
                results.Add(FlattenObject(item));
            }
        }
        else if (token is JObject obj)
        {
            // {"data": [{...}, {...}]}のようなネストされたデータの場合
            var dataToken = obj["data"] as JArray;
            if (dataToken != null)
            {
                foreach (var item in dataToken)
                {
                    results.Add(FlattenObject(item));
                }
            }
            else
            {
                results.Add(FlattenObject(obj));
            }
        }
        
        return results;
    }
    
    private Dictionary<string, object> FlattenObject(JToken token)
    {
        var result = new Dictionary<string, object>();
        FillDictionary(result, token, "");
        return result;
    }
    
    private void FillDictionary(Dictionary<string, object> dict, JToken token, string prefix)
    {
        switch (token.Type)
        {
            case JTokenType.Object:
                foreach (var prop in token.Children<JProperty>())
                {
                    FillDictionary(dict, prop.Value, 
                        string.IsNullOrEmpty(prefix) ? prop.Name : $"{prefix}.{prop.Name}");
                }
                break;
                
            case JTokenType.Array:
                int index = 0;
                foreach (var item in token.Children())
                {
                    FillDictionary(dict, item, $"{prefix}[{index}]");
                    index++;
                }
                break;
                
            default:
                dict[prefix] = ((JValue)token).Value;
                break;
        }
    }
}

ステップ5: Aspose.Cellsを使用してExcelに変換する

Excel変換を実装します：

using Aspose.Cells;
using Aspose.Cells.Utility;
using System;
using System.Collections.Generic;
using System.IO;

public class ExcelReportGenerator
{
    public void GenerateReport(string jsonData, string outputPath)
    {
        // 新しいワークブックを作成
        Workbook workbook = new Workbook();
        Worksheet sheet = workbook.Worksheets[0];
        
        // JSONレイアウトオプションを設定
        JsonLayoutOptions options = new JsonLayoutOptions
        {
            ArrayAsTable = true,
            ConvertNumericOrDate = true,
            IgnoreNull = true
        };
        
        // ヘッダーを太字にする
        options.TitleStyle = new CellsFactory().CreateStyle();
        options.TitleStyle.Font.IsBold = true;
        
        // JSONデータをインポート
        JsonUtility.ImportData(jsonData, sheet.Cells, 0, 0, options);
        
        // 列を自動調整
        sheet.AutoFitColumns();
        
        // ワークブックを保存
        workbook.Save(outputPath);
    }
    
    public void GenerateReportFromObjects(List<Dictionary<string, object>> data, string outputPath)
    {
        Workbook workbook = new Workbook();
        Worksheet sheet = workbook.Worksheets[0];
        
        // データがある場合はヘッダーを追加
        if (data.Count > 0)
        {
            int col = 0;
            foreach (var key in data[0].Keys)
            {
                // スタイル付きでヘッダーを追加
                Cell cell = sheet.Cells[0, col];
                cell.PutValue(key);
                
                Style style = cell.GetStyle();
                style.Font.IsBold = true;
                cell.SetStyle(style);
                
                col++;
            }
            
            // データ行を追加
            for (int row = 0; row < data.Count; row++)
            {
                col = 0;
                foreach (var value in data[row].Values)
                {
                    sheet.Cells[row + 1, col].PutValue(value);
                    col++;
                }
            }
        }
        
        // テーブルとしてフォーマット
        if (data.Count > 0)
        {
            int lastRow = data.Count;
            int lastCol = data[0].Count - 1;
            
            var tableRange = sheet.Cells.CreateRange(0, 0, lastRow + 1, lastCol + 1);
            sheet.ListObjects.Add(tableRange, "DataTable");
        }
        
        // 列を自動調整
        sheet.AutoFitColumns();
        
        // ワークブックを保存
        workbook.Save(outputPath);
    }
}

ステップ6: プロフェッショナルなフォーマットを追加する

Excel出力をプロフェッショナルなスタイリングで強化します：

public void ApplyProfessionalFormatting(Workbook workbook)
{
    Worksheet sheet = workbook.Worksheets[0];
    
    // タイトル用のスタイルを作成
    Style titleStyle = workbook.CreateStyle();
    titleStyle.Font.Size = 14;
    titleStyle.Font.IsBold = true;
    titleStyle.HorizontalAlignment = TextAlignmentType.Center;
    
    // レポートにタイトルを追加
    sheet.Cells.Merge(0, 0, 1, sheet.Cells.MaxColumn + 1);
    Cell titleCell = sheet.Cells[0, 0];
    titleCell.PutValue("APIデータレポート - " + DateTime.Now.ToString("yyyy-MM-dd"));
    titleCell.SetStyle(titleStyle);
    
    // タイトルの後に空白行を挿入
    sheet.Cells.InsertRow(1);
    
    // データに交互の行色を適用
    Style evenRowStyle = workbook.CreateStyle();
    evenRowStyle.ForegroundColor = Color.FromArgb(240, 240, 240);
    evenRowStyle.Pattern = BackgroundType.Solid;
    
    int dataStartRow = 3; // タイトルと空白行を考慮
    int lastRow = sheet.Cells.MaxRow;
    
    for (int row = dataStartRow; row <= lastRow; row += 2)
    {
        for (int col = 0; col <= sheet.Cells.MaxColumn; col++)
        {
            sheet.Cells[row, col].SetStyle(evenRowStyle);
        }
    }
    
    // ページヘッダーとフッターを追加
    sheet.PageSetup.SetHeader(1, "&\"Arial,Bold\"&14APIレポート");
    sheet.PageSetup.SetFooter(1, "ページ &P / &N");
    
    // 印刷オプションを設定
    sheet.PageSetup.Orientation = PageOrientationType.Landscape;
    sheet.PageSetup.FitToPagesWide = 1;
    sheet.PageSetup.TopMargin = 0.5;
    sheet.PageSetup.LeftMargin = 0.5;
    sheet.PageSetup.RightMargin = 0.5;
    sheet.PageSetup.BottomMargin = 0.5;
}

ステップ7: データ視覚化を追加する

チャートでレポートを強化します：

public void AddChartVisualization(Workbook workbook, int dataColumn)
{
    Worksheet sheet = workbook.Worksheets[0];
    Worksheet chartSheet = workbook.Worksheets.Add("チャート分析");
    
    // データ範囲を取得（ヘッダー行をスキップ）
    int lastRow = sheet.Cells.MaxRow;
    int nameColumn = 0; // 最初の列が名前/カテゴリを持つと仮定
    
    // チャートを追加
    int chartIndex = chartSheet.Charts.Add(ChartType.Column, 2, 2, 20, 10);
    Chart chart = chartSheet.Charts[chartIndex];
    
    // チャートのデータ範囲を設定
    chart.NSeries.Add($"Sheet1!B2:B{lastRow + 1}", true);
    chart.NSeries.CategoryData = $"Sheet1!A2:A{lastRow + 1}";
    
    // チャートのタイトルやその他のプロパティを設定
    chart.Title.Text = "データ分析";
    chart.Legend.Position = LegendPositionType.Bottom;
    
    // 追加のチャートカスタマイズ
    chart.NSeries[0].Area.ForegroundColor = Color.FromArgb(79, 129, 189);
    chart.PlotArea.Area.ForegroundColor = Color.White;
    
    // データラベルを追加
    chart.NSeries[0].DataLabels.IsValueShown = true;
    chart.NSeries[0].DataLabels.Position = DataLabelPositionType.OutsideEnd;
}

ステップ8: すべてをまとめる

すべてを結びつけるメインプログラムを作成します：

using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        try
        {
            // APIエンドポイントを設定
            string baseUrl = "https://api.example.com";
            string endpoint = "/data/endpoint";
            string apiKey = "your-api-key"; // 必要に応じて
            
            // APIに接続してデータを取得
            Console.WriteLine("APIに接続中...");
            var apiService = new ApiService(baseUrl);
            var jsonData = await apiService.GetApiDataAsync<string>(endpoint, apiKey);
            
            Console.WriteLine("データが正常に取得されました");
            
            // Excelレポートを生成
            Console.WriteLine("Excelレポートを生成中...");
            var reportGenerator = new ExcelReportGenerator();
            
            // オプション1: JSONからExcelへの直接変換
            string outputPath = "ApiReport_" + DateTime.Now.ToString("yyyyMMdd_HHmmss") + ".xlsx";
            reportGenerator.GenerateReport(jsonData, outputPath);
            
            // オプション2: JSONを処理して強化されたレポートを作成
            // var processor = new DataProcessor();
            // var processedData = processor.FlattenJsonData(jsonData);
            // reportGenerator.GenerateReportFromObjects(processedData, outputPath);
            
            Console.WriteLine($"レポートが{outputPath}に保存されました");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"エラー: {ex.Message}");
        }
    }
}

異なるAPIレスポンス構造の処理

REST APIはさまざまな形式でデータを返します。一般的な構造を処理する方法は以下の通りです：

1. オブジェクトの配列 

[
  { "id": 1, "name": "Product A", "price": 29.99 },
  { "id": 2, "name": "Product B", "price": 49.99 }
]

この構造には、次のように使用します：

JsonLayoutOptions options = new JsonLayoutOptions();
options.ArrayAsTable = true;
JsonUtility.ImportData(jsonData, sheet.Cells, 0, 0, options);

2. データ配列を持つネストされたオブジェクト 

{
  "status": "success",
  "data": [
    { "id": 1, "name": "Product A", "price": 29.99 },
    { "id": 2, "name": "Product B", "price": 49.99 }
  ]
}

DataProcessorクラスを使用して「data」配列を抽出するか、次のようにします：

// Newtonsoft.Jsonで解析
JObject jsonObj = JObject.Parse(jsonData);
JArray dataArray = (JArray)jsonObj["data"];

// 文字列に変換してインポート
string dataArrayJson = dataArray.ToString();
JsonUtility.ImportData(dataArrayJson, sheet.Cells, 0, 0, options);

3. ネストされた配列とオブジェクト 

{
  "categories": [
    {
      "name": "Electronics",
      "products": [
        { "id": 1, "name": "Laptop", "price": 999.99 },
        { "id": 2, "name": "Phone", "price": 699.99 }
      ]
    },
    {
      "name": "Books",
      "products": [
        { "id": 3, "name": "Novel", "price": 14.99 }
      ]
    }
  ]
}

複雑な構造の場合、複数のワークシートを作成します：

// JSONを解析
JObject root = JObject.Parse(jsonData);
JArray categories = (JArray)root["categories"];

// 各カテゴリのワークシートを作成
foreach (var category in categories)
{
    string categoryName = category["name"].ToString();
    Worksheet sheet = workbook.Worksheets.Add(categoryName);
    
    // 製品配列を取得してインポート
    JArray products = (JArray)category["products"];
    JsonUtility.ImportData(products.ToString(), sheet.Cells, 0, 0, options);
}

次のステップへ進む: スケジュールされたレポート

レポート生成を自動化するために、スケジューリング機能を追加します：

// タスクスケジューラーパッケージをインストール
// dotnet add package TaskScheduler

using Microsoft.Win32.TaskScheduler;

public void ScheduleDailyReportGeneration(string appPath)
{
    using (TaskService ts = new TaskService())
    {
        // 新しいタスクを作成
        TaskDefinition td = ts.NewTask();
        td.RegistrationInfo.Description = "毎日のAPIデータレポート生成";
        
        // 毎日午前7時に発火するトリガーを作成
        td.Triggers.Add(new DailyTrigger { StartBoundary = DateTime.Today.AddHours(7) });
        
        // アプリケーションを実行するアクションを作成
        td.Actions.Add(new ExecAction(appPath));
        
        // ルートフォルダにタスクを登録
        ts.RootFolder.RegisterTaskDefinition("DailyApiReport", td);
    }
}

考慮すべき高度な機能

  1. メール配信 - 自動的にレポートをメールで送信
  2. 複数API統合 - 複数のAPIからデータを統合
  3. テンプレートベースのレポート - 一貫したブランディングのためにExcelテンプレートを使用
  4. ダッシュボード作成 - インタラクティブなExcelダッシュボードを生成
  5. エラー追跡と報告 - 問題をログに記録し、成功/失敗を報告

このガイドに従うことで、APIデータを取得し、プロフェッショナルなExcelレポートに変換するプロセスを自動化する堅牢なC#アプリケーションを作成しました。これにより、時間を節約し、正確性を確保し、ビジネス価値を提供します。

 日本語