How to Transform API Responses to Excel Reports in C#

In der heutigen datengesteuerten Welt verlassen sich Unternehmen stark auf REST-APIs für den Datenaustausch. Viele Stakeholder bevorzugen jedoch, diese Daten im Excel-Format für Analysen und Berichterstattung zu konsumieren. Dieser Leitfaden zeigt, wie man eine vollständige C#-Anwendung erstellt, die:

Mit REST-APIs verbindet
JSON-Antwortdaten abruft
Die Daten in professionell formatierte Excel-Berichte konvertiert
Visualisierungen mit Diagrammen und Tabellen hinzufügt

Geschäftswert

Diese Lösung bietet erheblichen Wert durch:

Automatisierung manueller Datenextraktions- und Berichtserstellungsprozesse
Sicherstellung der Datenintegrität durch Eliminierung manueller Kopiervorgänge
Bereitstellung konsistenter Berichtformatierung
Ermöglichung der geplanten Berichtserstellung

Schritt-für-Schritt-Implementierungsanleitung

Schritt 1: Erstellen einer neuen C#-Anwendung

Beginnen Sie mit der Erstellung einer neuen Konsolenanwendung:

dotnet new console -n ApiToExcelReporter
cd ApiToExcelReporter

Schritt 2: Erforderliche Pakete installieren

Fügen Sie die notwendigen NuGet-Pakete hinzu:

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

Schritt 3: Implementierung des REST-API-Clients

Erstellen Sie einen Dienst für die API-Kommunikation:

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);
        
        // Authentifizierung hinzufügen, falls erforderlich
        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-Aufruf fehlgeschlagen: {response.ErrorMessage}");
    }
}

Schritt 4: JSON-Antwortdaten verarbeiten

Fügen Sie eine Klasse hinzu, um die JSON-Daten zu verarbeiten:

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);
        
        // Verschiedene JSON-Strukturen behandeln
        if (token is JArray array)
        {
            foreach (var item in array)
            {
                results.Add(FlattenObject(item));
            }
        }
        else if (token is JObject obj)
        {
            // Für verschachtelte Daten wie {"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;
        }
    }
}

Schritt 5: Mit Aspose.Cells in Excel konvertieren

Implementieren Sie die Excel-Konvertierung:

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)
    {
        // Erstellen Sie eine neue Arbeitsmappe
        Workbook workbook = new Workbook();
        Worksheet sheet = workbook.Worksheets[0];
        
        // JSON-Layoutoptionen konfigurieren
        JsonLayoutOptions options = new JsonLayoutOptions
        {
            ArrayAsTable = true,
            ConvertNumericOrDate = true,
            IgnoreNull = true
        };
        
        // Überschriften fett machen
        options.TitleStyle = new CellsFactory().CreateStyle();
        options.TitleStyle.Font.IsBold = true;
        
        // JSON-Daten importieren
        JsonUtility.ImportData(jsonData, sheet.Cells, 0, 0, options);
        
        // Spalten automatisch anpassen
        sheet.AutoFitColumns();
        
        // Arbeitsmappe speichern
        workbook.Save(outputPath);
    }
    
    public void GenerateReportFromObjects(List<Dictionary<string, object>> data, string outputPath)
    {
        Workbook workbook = new Workbook();
        Worksheet sheet = workbook.Worksheets[0];
        
        // Überschriften hinzufügen, wenn Daten vorhanden sind
        if (data.Count > 0)
        {
            int col = 0;
            foreach (var key in data[0].Keys)
            {
                // Überschrift mit Stil hinzufügen
                Cell cell = sheet.Cells[0, col];
                cell.PutValue(key);
                
                Style style = cell.GetStyle();
                style.Font.IsBold = true;
                cell.SetStyle(style);
                
                col++;
            }
            
            // Datenzeilen hinzufügen
            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++;
                }
            }
        }
        
        // Als Tabelle formatieren
        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");
        }
        
        // Spalten automatisch anpassen
        sheet.AutoFitColumns();
        
        // Arbeitsmappe speichern
        workbook.Save(outputPath);
    }
}

Schritt 6: Professionelle Formatierung hinzufügen

Verbessern Sie die Excel-Ausgabe mit professionellem Styling:

public void ApplyProfessionalFormatting(Workbook workbook)
{
    Worksheet sheet = workbook.Worksheets[0];
    
    // Erstellen Sie einen Stil für den Titel
    Style titleStyle = workbook.CreateStyle();
    titleStyle.Font.Size = 14;
    titleStyle.Font.IsBold = true;
    titleStyle.HorizontalAlignment = TextAlignmentType.Center;
    
    // Fügen Sie dem Bericht einen Titel hinzu
    sheet.Cells.Merge(0, 0, 1, sheet.Cells.MaxColumn + 1);
    Cell titleCell = sheet.Cells[0, 0];
    titleCell.PutValue("API-Datenbericht - " + DateTime.Now.ToString("yyyy-MM-dd"));
    titleCell.SetStyle(titleStyle);
    
    // Fügen Sie eine leere Zeile nach dem Titel ein
    sheet.Cells.InsertRow(1);
    
    // Wenden Sie abwechselnde Zeilenfarben auf die Daten an
    Style evenRowStyle = workbook.CreateStyle();
    evenRowStyle.ForegroundColor = Color.FromArgb(240, 240, 240);
    evenRowStyle.Pattern = BackgroundType.Solid;
    
    int dataStartRow = 3; // Berücksichtigung von Titel und leerer Zeile
    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);
        }
    }
    
    // Fügen Sie Kopf- und Fußzeile hinzu
    sheet.PageSetup.SetHeader(1, "&\"Arial,Bold\"&14API-Bericht");
    sheet.PageSetup.SetFooter(1, "Seite &P von &N");
    
    // Druckoptionen festlegen
    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;
}

Schritt 7: Datenvisualisierung hinzufügen

Verbessern Sie den Bericht mit Diagrammen:

public void AddChartVisualization(Workbook workbook, int dataColumn)
{
    Worksheet sheet = workbook.Worksheets[0];
    Worksheet chartSheet = workbook.Worksheets.Add("Diagrammanalyse");
    
    // Holen Sie sich den Datenbereich (Überschrift überspringen)
    int lastRow = sheet.Cells.MaxRow;
    int nameColumn = 0; // Angenommen, die erste Spalte hat Namen/Kategorien
    
    // Fügen Sie ein Diagramm hinzu
    int chartIndex = chartSheet.Charts.Add(ChartType.Column, 2, 2, 20, 10);
    Chart chart = chartSheet.Charts[chartIndex];
    
    // Setzen Sie den Datenbereich für das Diagramm
    chart.NSeries.Add($"Sheet1!B2:B{lastRow + 1}", true);
    chart.NSeries.CategoryData = $"Sheet1!A2:A{lastRow + 1}";
    
    // Diagrammtitel und andere Eigenschaften festlegen
    chart.Title.Text = "Datenanalyse";
    chart.Legend.Position = LegendPositionType.Bottom;
    
    // Zusätzliche Diagrammanpassungen
    chart.NSeries[0].Area.ForegroundColor = Color.FromArgb(79, 129, 189);
    chart.PlotArea.Area.ForegroundColor = Color.White;
    
    // Datenbeschriftungen hinzufügen
    chart.NSeries[0].DataLabels.IsValueShown = true;
    chart.NSeries[0].DataLabels.Position = DataLabelPositionType.OutsideEnd;
}

Schritt 8: Alles zusammenfügen

Erstellen Sie das Hauptprogramm, das alles zusammenbindet:

using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        try
        {
            // API-Endpunkt konfigurieren
            string baseUrl = "https://api.example.com";
            string endpoint = "/data/endpoint";
            string apiKey = "your-api-key"; // Falls erforderlich
            
            // Mit der API verbinden und Daten abrufen
            Console.WriteLine("Verbindung zur API wird hergestellt...");
            var apiService = new ApiService(baseUrl);
            var jsonData = await apiService.GetApiDataAsync<string>(endpoint, apiKey);
            
            Console.WriteLine("Daten erfolgreich abgerufen");
            
            // Excel-Bericht generieren
            Console.WriteLine("Excel-Bericht wird generiert...");
            var reportGenerator = new ExcelReportGenerator();
            
            // Option 1: Direkte JSON-zu-Excel-Konvertierung
            string outputPath = "ApiReport_" + DateTime.Now.ToString("yyyyMMdd_HHmmss") + ".xlsx";
            reportGenerator.GenerateReport(jsonData, outputPath);
            
            // Option 2: JSON verarbeiten und verbesserten Bericht erstellen
            // var processor = new DataProcessor();
            // var processedData = processor.FlattenJsonData(jsonData);
            // reportGenerator.GenerateReportFromObjects(processedData, outputPath);
            
            Console.WriteLine($"Bericht gespeichert unter {outputPath}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Fehler: {ex.Message}");
        }
    }
}

Umgang mit verschiedenen API-Antwortstrukturen

REST-APIs geben Daten in verschiedenen Formaten zurück. So gehen Sie mit häufigen Strukturen um:

1. Array von Objekten

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

Für diese Struktur verwenden Sie:

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

2. Verschachteltes Objekt mit Daten-Array

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

Verwenden Sie die DataProcessor-Klasse, um das “data”-Array zu extrahieren, oder:

// Mit Newtonsoft.Json analysieren
JObject jsonObj = JObject.Parse(jsonData);
JArray dataArray = (JArray)jsonObj["data"];

// In String konvertieren und importieren
string dataArrayJson = dataArray.ToString();
JsonUtility.ImportData(dataArrayJson, sheet.Cells, 0, 0, options);

3. Verschachtelte Arrays und Objekte

{
  "categories": [
    {
      "name": "Elektronik",
      "products": [
        { "id": 1, "name": "Laptop", "price": 999.99 },
        { "id": 2, "name": "Telefon", "price": 699.99 }
      ]
    },
    {
      "name": "Bücher",
      "products": [
        { "id": 3, "name": "Roman", "price": 14.99 }
      ]
    }
  ]
}

Für komplexe Strukturen erstellen Sie mehrere Arbeitsblätter:

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

// Erstellen Sie ein Arbeitsblatt für jede Kategorie
foreach (var category in categories)
{
    string categoryName = category["name"].ToString();
    Worksheet sheet = workbook.Worksheets.Add(categoryName);
    
    // Holen und importieren Sie das Produkte-Array
    JArray products = (JArray)category["products"];
    JsonUtility.ImportData(products.ToString(), sheet.Cells, 0, 0, options);
}

Den nächsten Schritt gehen: Geplante Berichte

Um die Berichtserstellung zu automatisieren, fügen Sie Planungsfunktionen hinzu:

// Installieren Sie das Task Scheduler-Paket
// dotnet add package TaskScheduler

using Microsoft.Win32.TaskScheduler;

public void ScheduleDailyReportGeneration(string appPath)
{
    using (TaskService ts = new TaskService())
    {
        // Erstellen Sie eine neue Aufgabe
        TaskDefinition td = ts.NewTask();
        td.RegistrationInfo.Description = "Tägliche API-Datenberichtserstellung";
        
        // Erstellen Sie einen Trigger, der täglich um 7 Uhr auslöst
        td.Triggers.Add(new DailyTrigger { StartBoundary = DateTime.Today.AddHours(7) });
        
        // Erstellen Sie eine Aktion, die die Anwendung ausführt
        td.Actions.Add(new ExecAction(appPath));
        
        // Registrieren Sie die Aufgabe im Stammordner
        ts.RootFolder.RegisterTaskDefinition("DailyApiReport", td);
    }
}

Erweiterte Funktionen, die Sie in Betracht ziehen sollten

E-Mail-Zustellung - Berichte automatisch per E-Mail senden
Multi-API-Integration - Daten aus mehreren APIs kombinieren
Vorlagenbasierte Berichte - Verwenden Sie Excel-Vorlagen für konsistente Markenbildung
Dashboard-Erstellung - Interaktive Excel-Dashboards generieren
Fehlerverfolgung und -berichterstattung - Probleme protokollieren und über Erfolg/Misserfolg berichten

Indem Sie diesem Leitfaden folgen, haben Sie eine robuste C#-Anwendung erstellt, die den Prozess des Abrufens von API-Daten und deren Umwandlung in professionelle Excel-Berichte automatisiert – Zeit spart, Genauigkeit gewährleistet und geschäftlichen Wert liefert.