Com transformar les respostes d'API en els informes d'Excel en C#

En el món basat en dades d’avui, les empreses es basen molt en les APIs REST per a l’intercanvi de dades. No obstant això, moltes parts interessades prefereixen consumir aquestes dades en format Excel per a l’anàlisi i la comunicaci:

Connectar-se a la resta d’apis
Recupera les dades de resposta JSON
Converteix les dades en informes de format professional d’Excel
Ads visualització amb gràfics i taules

Valor empresarial

Aquesta solució dóna valor significatiu per:

Automatització manual d’extracció de dades i processos de creació de reportes
Assegurar l’exactitud de les dades eliminant la còpia manual
Proporcionar un format de reportatge coherent
Capacitat per a la generació de informes programades

Guia d’implementació de pas a pas

Pas 1: Creació d’una nova aplicació C#

Comencem creant una nova aplicació de consola:

dotnet new console -n ApiToExcelReporter
cd ApiToExcelReporter

Pas 2: Instal·lar els paquets necessaris

Afegir els paquets necessaris de NuGet:

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

Pas 3: Implementar el client REST API

Crear un servei per a la comunicació 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);
        
        // Add authentication if needed
        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 call failed: {response.ErrorMessage}");
    }
}

Pas 4: Processar dades de resposta JSON

Afegir una classe per processar les dades 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);
        
        // Handle different JSON structures
        if (token is JArray array)
        {
            foreach (var item in array)
            {
                results.Add(FlattenObject(item));
            }
        }
        else if (token is JObject obj)
        {
            // For nested data like {"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;
        }
    }
}

Pas 5: Convertir a Excel amb Aspose.Cells

Implementació de la conversió d’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)
    {
        // Create a new workbook
        Workbook workbook = new Workbook();
        Worksheet sheet = workbook.Worksheets[0];
        
        // Configure JSON layout options
        JsonLayoutOptions options = new JsonLayoutOptions
        {
            ArrayAsTable = true,
            ConvertNumericOrDate = true,
            IgnoreNull = true
        };
        
        // Make headers bold
        options.TitleStyle = new CellsFactory().CreateStyle();
        options.TitleStyle.Font.IsBold = true;
        
        // Import JSON data
        JsonUtility.ImportData(jsonData, sheet.Cells, 0, 0, options);
        
        // Auto-fit columns
        sheet.AutoFitColumns();
        
        // Save the workbook
        workbook.Save(outputPath);
    }
    
    public void GenerateReportFromObjects(List<Dictionary<string, object>> data, string outputPath)
    {
        Workbook workbook = new Workbook();
        Worksheet sheet = workbook.Worksheets[0];
        
        // Add headers if there's data
        if (data.Count > 0)
        {
            int col = 0;
            foreach (var key in data[0].Keys)
            {
                // Add header with styling
                Cell cell = sheet.Cells[0, col];
                cell.PutValue(key);
                
                Style style = cell.GetStyle();
                style.Font.IsBold = true;
                cell.SetStyle(style);
                
                col++;
            }
            
            // Add data rows
            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++;
                }
            }
        }
        
        // Format as a table
        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");
        }
        
        // Auto-fit columns
        sheet.AutoFitColumns();
        
        // Save the workbook
        workbook.Save(outputPath);
    }
}

Pas 6: Afegir formatació professional

Millorar la producció d’Excel amb estil professional:

public void ApplyProfessionalFormatting(Workbook workbook)
{
    Worksheet sheet = workbook.Worksheets[0];
    
    // Create a style for the title
    Style titleStyle = workbook.CreateStyle();
    titleStyle.Font.Size = 14;
    titleStyle.Font.IsBold = true;
    titleStyle.HorizontalAlignment = TextAlignmentType.Center;
    
    // Add a title to the report
    sheet.Cells.Merge(0, 0, 1, sheet.Cells.MaxColumn + 1);
    Cell titleCell = sheet.Cells[0, 0];
    titleCell.PutValue("API Data Report - " + DateTime.Now.ToString("yyyy-MM-dd"));
    titleCell.SetStyle(titleStyle);
    
    // Insert a blank row after the title
    sheet.Cells.InsertRow(1);
    
    // Apply alternating row colors to the data
    Style evenRowStyle = workbook.CreateStyle();
    evenRowStyle.ForegroundColor = Color.FromArgb(240, 240, 240);
    evenRowStyle.Pattern = BackgroundType.Solid;
    
    int dataStartRow = 3; // Accounting for title and blank row
    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);
        }
    }
    
    // Add page header and footer
    sheet.PageSetup.SetHeader(1, "&\"Arial,Bold\"&14API Report");
    sheet.PageSetup.SetFooter(1, "Page &P of &N");
    
    // Set print options
    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;
}

Pas 7: Afegir visualització de dades

Millorar l’informe amb els gràfics:

public void AddChartVisualization(Workbook workbook, int dataColumn)
{
    Worksheet sheet = workbook.Worksheets[0];
    Worksheet chartSheet = workbook.Worksheets.Add("Chart Analysis");
    
    // Get the data range (skip header row)
    int lastRow = sheet.Cells.MaxRow;
    int nameColumn = 0; // Assuming first column has names/categories
    
    // Add a chart
    int chartIndex = chartSheet.Charts.Add(ChartType.Column, 2, 2, 20, 10);
    Chart chart = chartSheet.Charts[chartIndex];
    
    // Set the data range for the chart
    chart.NSeries.Add($"Sheet1!B2:B{lastRow + 1}", true);
    chart.NSeries.CategoryData = $"Sheet1!A2:A{lastRow + 1}";
    
    // Set chart title and other properties
    chart.Title.Text = "Data Analysis";
    chart.Legend.Position = LegendPositionType.Bottom;
    
    // Additional chart customization
    chart.NSeries[0].Area.ForegroundColor = Color.FromArgb(79, 129, 189);
    chart.PlotArea.Area.ForegroundColor = Color.White;
    
    // Add data labels
    chart.NSeries[0].DataLabels.IsValueShown = true;
    chart.NSeries[0].DataLabels.Position = DataLabelPositionType.OutsideEnd;
}

Etapa 8: Posa’t tot junts

Crea el programa principal que connecta tot:

using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        try
        {
            // Configure API endpoint
            string baseUrl = "https://api.example.com";
            string endpoint = "/data/endpoint";
            string apiKey = "your-api-key"; // If needed
            
            // Connect to API and get data
            Console.WriteLine("Connecting to API...");
            var apiService = new ApiService(baseUrl);
            var jsonData = await apiService.GetApiDataAsync<string>(endpoint, apiKey);
            
            Console.WriteLine("Data retrieved successfully");
            
            // Generate Excel report
            Console.WriteLine("Generating Excel report...");
            var reportGenerator = new ExcelReportGenerator();
            
            // Option 1: Direct JSON to Excel conversion
            string outputPath = "ApiReport_" + DateTime.Now.ToString("yyyyMMdd_HHmmss") + ".xlsx";
            reportGenerator.GenerateReport(jsonData, outputPath);
            
            // Option 2: Process JSON and create enhanced report
            // var processor = new DataProcessor();
            // var processedData = processor.FlattenJsonData(jsonData);
            // reportGenerator.GenerateReportFromObjects(processedData, outputPath);
            
            Console.WriteLine($"Report saved to {outputPath}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}

Tractament de diferents estructures de resposta API

REST APIs retorna dades en diversos formats. aquí és com gestionar estructures comunes:

1 Arreu d’objectes

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

Per a aquesta estructura, utilitzeu:

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

Objecte Nested amb Array de Dades

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

Utilitzeu la classe de processador de dades per extreure l’arrel de dades, o:

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

// Convert to string and import
string dataArrayJson = dataArray.ToString();
JsonUtility.ImportData(dataArrayJson, sheet.Cells, 0, 0, options);

3.- Arrays i objectes desgastats

{
  "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 }
      ]
    }
  ]
}

Per a estructures complexes, crear múltiples taules de treball:

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

// Create a worksheet for each category
foreach (var category in categories)
{
    string categoryName = category["name"].ToString();
    Worksheet sheet = workbook.Worksheets.Add(categoryName);
    
    // Get and import the products array
    JArray products = (JArray)category["products"];
    JsonUtility.ImportData(products.ToString(), sheet.Cells, 0, 0, options);
}

Portar-lo al següent nivell: informes programats

Per automatitzar la generació de informes, afegir capacitats de programaci:

// Install Task Scheduler package
// dotnet add package TaskScheduler

using Microsoft.Win32.TaskScheduler;

public void ScheduleDailyReportGeneration(string appPath)
{
    using (TaskService ts = new TaskService())
    {
        // Create a new task
        TaskDefinition td = ts.NewTask();
        td.RegistrationInfo.Description = "Daily API Data Report Generation";
        
        // Create a trigger that will fire daily at 7am
        td.Triggers.Add(new DailyTrigger { StartBoundary = DateTime.Today.AddHours(7) });
        
        // Create an action that will run the application
        td.Actions.Add(new ExecAction(appPath));
        
        // Register the task in the root folder
        ts.RootFolder.RegisterTaskDefinition("DailyApiReport", td);
    }
}

Característiques avançades a considerar

Enviament de correu electrònic - Envia informes automàticament per correu
Multi-API integració - Combina dades de múltiples API
Raports basats en temàtics - Utilitzar els templats d’Excel per a la marcació consistent
Creació de dashboard - Generar dashboards interactius d’Excel
Tractament d’errors i reportatge - Problemes de registre i informe sobre èxit / fracàs

En seguir aquest guia, s’ha creat una aplicació C# robusta que automatitza el procés de recuperació de dades d’API i la conversió en informes professionals d’Excel - estalvi de temps, garantia d’exactitud i lliurament de valor empresarial.