Jak przekształcić odpowiedzi API na raporty Excel w C#

W dzisiejszym świecie opartym na danych, firmy w dużym stopniu polegają na interfejsach API REST do wymiany danych. Jednak wielu interesariuszy woli konsumować te dane w formacie Excel do analizy i raportowania. Ten przewodnik pokazuje, jak zbudować kompletną aplikację C#, która:

Łączy się z interfejsami API REST
Pobiera dane odpowiedzi w formacie JSON
Konwertuje dane na profesjonalnie sformatowane raporty Excel
Dodaje wizualizację za pomocą wykresów i tabel

Wartość biznesowa

To rozwiązanie dostarcza znaczącą wartość poprzez:

Automatyzację ręcznego wydobywania danych i procesów tworzenia raportów
Zapewnienie dokładności danych poprzez eliminację ręcznego kopiowania
Umożliwienie spójnego formatowania raportów
Umożliwienie generowania raportów według harmonogramu

Przewodnik po wdrażaniu krok po kroku

Krok 1: Utwórz nową aplikację C#

Zacznij od utworzenia nowej aplikacji konsolowej:

dotnet new console -n ApiToExcelReporter
cd ApiToExcelReporter

Krok 2: Zainstaluj wymagane pakiety

Dodaj niezbędne pakiety NuGet:

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

Krok 3: Zaimplementuj klienta API REST

Utwórz serwis do komunikacji z 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);
        
        // Dodaj uwierzytelnienie, jeśli to konieczne
        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($"Wywołanie API nie powiodło się: {response.ErrorMessage}");
    }
}

Krok 4: Przetwórz dane odpowiedzi JSON

Dodaj klasę do przetwarzania danych 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);
        
        // Obsłuż różne struktury JSON
        if (token is JArray array)
        {
            foreach (var item in array)
            {
                results.Add(FlattenObject(item));
            }
        }
        else if (token is JObject obj)
        {
            // Dla zagnieżdżonych danych jak {"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;
        }
    }
}

Krok 5: Konwertuj na Excel za pomocą Aspose.Cells

Zaimplementuj konwersję do Excela:

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)
    {
        // Utwórz nowy skoroszyt
        Workbook workbook = new Workbook();
        Worksheet sheet = workbook.Worksheets[0];
        
        // Skonfiguruj opcje układu JSON
        JsonLayoutOptions options = new JsonLayoutOptions
        {
            ArrayAsTable = true,
            ConvertNumericOrDate = true,
            IgnoreNull = true
        };
        
        // Uczyń nagłówki pogrubionymi
        options.TitleStyle = new CellsFactory().CreateStyle();
        options.TitleStyle.Font.IsBold = true;
        
        // Importuj dane JSON
        JsonUtility.ImportData(jsonData, sheet.Cells, 0, 0, options);
        
        // Dopasuj szerokości kolumn
        sheet.AutoFitColumns();
        
        // Zapisz skoroszyt
        workbook.Save(outputPath);
    }
    
    public void GenerateReportFromObjects(List<Dictionary<string, object>> data, string outputPath)
    {
        Workbook workbook = new Workbook();
        Worksheet sheet = workbook.Worksheets[0];
        
        // Dodaj nagłówki, jeśli są dane
        if (data.Count > 0)
        {
            int col = 0;
            foreach (var key in data[0].Keys)
            {
                // Dodaj nagłówek z formatowaniem
                Cell cell = sheet.Cells[0, col];
                cell.PutValue(key);
                
                Style style = cell.GetStyle();
                style.Font.IsBold = true;
                cell.SetStyle(style);
                
                col++;
            }
            
            // Dodaj wiersze z danymi
            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++;
                }
            }
        }
        
        // Sformatuj jako tabelę
        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");
        }
        
        // Dopasuj szerokości kolumn
        sheet.AutoFitColumns();
        
        // Zapisz skoroszyt
        workbook.Save(outputPath);
    }
}

Krok 6: Dodaj profesjonalne formatowanie

Ulepsz wynik Excela za pomocą profesjonalnego stylu:

public void ApplyProfessionalFormatting(Workbook workbook)
{
    Worksheet sheet = workbook.Worksheets[0];
    
    // Utwórz styl dla tytułu
    Style titleStyle = workbook.CreateStyle();
    titleStyle.Font.Size = 14;
    titleStyle.Font.IsBold = true;
    titleStyle.HorizontalAlignment = TextAlignmentType.Center;
    
    // Dodaj tytuł do raportu
    sheet.Cells.Merge(0, 0, 1, sheet.Cells.MaxColumn + 1);
    Cell titleCell = sheet.Cells[0, 0];
    titleCell.PutValue("Raport danych API - " + DateTime.Now.ToString("yyyy-MM-dd"));
    titleCell.SetStyle(titleStyle);
    
    // Wstaw pusty wiersz po tytule
    sheet.Cells.InsertRow(1);
    
    // Zastosuj naprzemienne kolory wierszy do danych
    Style evenRowStyle = workbook.CreateStyle();
    evenRowStyle.ForegroundColor = Color.FromArgb(240, 240, 240);
    evenRowStyle.Pattern = BackgroundType.Solid;
    
    int dataStartRow = 3; // Uwzględniając tytuł i pusty wiersz
    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);
        }
    }
    
    // Dodaj nagłówek i stopkę strony
    sheet.PageSetup.SetHeader(1, "&\"Arial,Bold\"&14Raport API");
    sheet.PageSetup.SetFooter(1, "Strona &P z &N");
    
    // Ustaw opcje drukowania
    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;
}

Krok 7: Dodaj wizualizację danych

Ulepsz raport za pomocą wykresów:

public void AddChartVisualization(Workbook workbook, int dataColumn)
{
    Worksheet sheet = workbook.Worksheets[0];
    Worksheet chartSheet = workbook.Worksheets.Add("Analiza wykresu");
    
    // Uzyskaj zakres danych (pomiń wiersz nagłówka)
    int lastRow = sheet.Cells.MaxRow;
    int nameColumn = 0; // Zakładając, że pierwsza kolumna zawiera nazwy/kategorie
    
    // Dodaj wykres
    int chartIndex = chartSheet.Charts.Add(ChartType.Column, 2, 2, 20, 10);
    Chart chart = chartSheet.Charts[chartIndex];
    
    // Ustaw zakres danych dla wykresu
    chart.NSeries.Add($"Sheet1!B2:B{lastRow + 1}", true);
    chart.NSeries.CategoryData = $"Sheet1!A2:A{lastRow + 1}";
    
    // Ustaw tytuł wykresu i inne właściwości
    chart.Title.Text = "Analiza danych";
    chart.Legend.Position = LegendPositionType.Bottom;
    
    // Dodatkowe dostosowanie wykresu
    chart.NSeries[0].Area.ForegroundColor = Color.FromArgb(79, 129, 189);
    chart.PlotArea.Area.ForegroundColor = Color.White;
    
    // Dodaj etykiety danych
    chart.NSeries[0].DataLabels.IsValueShown = true;
    chart.NSeries[0].DataLabels.Position = DataLabelPositionType.OutsideEnd;
}

Krok 8: Połącz wszystko

Utwórz główny program, który łączy wszystko:

using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        try
        {
            // Skonfiguruj punkt końcowy API
            string baseUrl = "https://api.example.com";
            string endpoint = "/data/endpoint";
            string apiKey = "your-api-key"; // Jeśli potrzebne
            
            // Połącz się z API i pobierz dane
            Console.WriteLine("Łączenie z API...");
            var apiService = new ApiService(baseUrl);
            var jsonData = await apiService.GetApiDataAsync<string>(endpoint, apiKey);
            
            Console.WriteLine("Dane pobrane pomyślnie");
            
            // Generuj raport Excel
            Console.WriteLine("Generowanie raportu Excel...");
            var reportGenerator = new ExcelReportGenerator();
            
            // Opcja 1: Bezpośrednia konwersja JSON do Excela
            string outputPath = "ApiReport_" + DateTime.Now.ToString("yyyyMMdd_HHmmss") + ".xlsx";
            reportGenerator.GenerateReport(jsonData, outputPath);
            
            // Opcja 2: Przetwórz JSON i utwórz ulepszony raport
            // var processor = new DataProcessor();
            // var processedData = processor.FlattenJsonData(jsonData);
            // reportGenerator.GenerateReportFromObjects(processedData, outputPath);
            
            Console.WriteLine($"Raport zapisany w {outputPath}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Błąd: {ex.Message}");
        }
    }
}

Obsługa różnych struktur odpowiedzi API

Interfejsy API REST zwracają dane w różnych formatach. Oto jak obsługiwać typowe struktury:

1. Tablica obiektów

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

Dla tej struktury użyj:

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

2. Zagnieżdżony obiekt z tablicą danych

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

Użyj klasy DataProcessor, aby wyodrębnić tablicę “data”, lub:

// Parsuj za pomocą Newtonsoft.Json
JObject jsonObj = JObject.Parse(jsonData);
JArray dataArray = (JArray)jsonObj["data"];

// Konwertuj na string i zaimportuj
string dataArrayJson = dataArray.ToString();
JsonUtility.ImportData(dataArrayJson, sheet.Cells, 0, 0, options);

3. Zagnieżdżone tablice i obiekty

{
  "categories": [
    {
      "name": "Elektronika",
      "products": [
        { "id": 1, "name": "Laptop", "price": 999.99 },
        { "id": 2, "name": "Telefon", "price": 699.99 }
      ]
    },
    {
      "name": "Książki",
      "products": [
        { "id": 3, "name": "Powieść", "price": 14.99 }
      ]
    }
  ]
}

Dla złożonych struktur utwórz wiele arkuszy roboczych:

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

// Utwórz arkusz dla każdej kategorii
foreach (var category in categories)
{
    string categoryName = category["name"].ToString();
    Worksheet sheet = workbook.Worksheets.Add(categoryName);
    
    // Uzyskaj i zaimportuj tablicę produktów
    JArray products = (JArray)category["products"];
    JsonUtility.ImportData(products.ToString(), sheet.Cells, 0, 0, options);
}

Przeniesienie na wyższy poziom: Raporty zaplanowane

Aby zautomatyzować generowanie raportów, dodaj możliwości harmonogramowania:

// Zainstaluj pakiet Task Scheduler
// dotnet add package TaskScheduler

using Microsoft.Win32.TaskScheduler;

public void ScheduleDailyReportGeneration(string appPath)
{
    using (TaskService ts = new TaskService())
    {
        // Utwórz nowe zadanie
        TaskDefinition td = ts.NewTask();
        td.RegistrationInfo.Description = "Codzienne generowanie raportu danych API";
        
        // Utwórz wyzwalacz, który uruchomi się codziennie o 7:00
        td.Triggers.Add(new DailyTrigger { StartBoundary = DateTime.Today.AddHours(7) });
        
        // Utwórz akcję, która uruchomi aplikację
        td.Actions.Add(new ExecAction(appPath));
        
        // Zarejestruj zadanie w głównym folderze
        ts.RootFolder.RegisterTaskDefinition("CodziennyRaportApi", td);
    }
}

Zaawansowane funkcje do rozważenia

Dostawa e-mail - Automatyczne wysyłanie raportów e-mailem
Integracja z wieloma API - Łączenie danych z wielu API
Raporty oparte na szablonach - Użycie szablonów Excela dla spójnego brandingu
Tworzenie pulpitów nawigacyjnych - Generowanie interaktywnych pulpitów Excela
Śledzenie błędów i raportowanie - Rejestrowanie problemów i raportowanie sukcesów/niepowodzeń

Postępując zgodnie z tym przewodnikiem, stworzyłeś solidną aplikację C#, która automatyzuje proces pobierania danych z API i konwertowania ich na profesjonalne raporty Excel—oszczędzając czas, zapewniając dokładność i dostarczając wartość biznesową.