Hur man omvandlar API-svar till Excel-rapporter i C#

I dagens datadrivna värld förlitar sig företag i hög grad på REST API:er för datautbyte. Många intressenter föredrar dock att konsumera denna data i Excel-format för analys och rapportering. Denna guide visar hur man bygger en komplett C#-applikation som:

Ansluter till REST API:er
Hämtar JSON-svardata
Konverterar data till professionellt formaterade Excel-rapporter
Lägger till visualiseringar med diagram och tabeller

Affärsvärde

Denna lösning levererar betydande värde genom att:

Automatisera manuella datautvinnings- och rapporteringsprocesser
Säkerställa datakvalitet genom att eliminera manuell kopiering
Tillhandahålla konsekvent rapportformat
Möjliggöra schemalagd rapportgenerering

Steg-för-steg implementeringsguide

Steg 1: Skapa en ny C#-applikation

Börja med att skapa en ny konsolapplikation:

dotnet new console -n ApiToExcelReporter
cd ApiToExcelReporter

Steg 2: Installera nödvändiga paket

Lägg till de nödvändiga NuGet-paketen:

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

Steg 3: Implementera REST API-klienten

Skapa en tjänst för 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);
        
        // Lägg till autentisering om det behövs
        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-anrop misslyckades: {response.ErrorMessage}");
    }
}

Steg 4: Bearbeta JSON-svardata

Lägg till en klass för att bearbeta JSON-data:

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);
        
        // Hantera olika JSON-strukturer
        if (token is JArray array)
        {
            foreach (var item in array)
            {
                results.Add(FlattenObject(item));
            }
        }
        else if (token is JObject obj)
        {
            // För nästlad data som {"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;
        }
    }
}

Steg 5: Konvertera till Excel med Aspose.Cells

Implementera Excel-konverteringen:

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)
    {
        // Skapa en ny arbetsbok
        Workbook workbook = new Workbook();
        Worksheet sheet = workbook.Worksheets[0];
        
        // Konfigurera JSON-layoutalternativ
        JsonLayoutOptions options = new JsonLayoutOptions
        {
            ArrayAsTable = true,
            ConvertNumericOrDate = true,
            IgnoreNull = true
        };
        
        // Gör rubrikerna feta
        options.TitleStyle = new CellsFactory().CreateStyle();
        options.TitleStyle.Font.IsBold = true;
        
        // Importera JSON-data
        JsonUtility.ImportData(jsonData, sheet.Cells, 0, 0, options);
        
        // Autofit kolumner
        sheet.AutoFitColumns();
        
        // Spara arbetsboken
        workbook.Save(outputPath);
    }
    
    public void GenerateReportFromObjects(List<Dictionary<string, object>> data, string outputPath)
    {
        Workbook workbook = new Workbook();
        Worksheet sheet = workbook.Worksheets[0];
        
        // Lägg till rubriker om det finns data
        if (data.Count > 0)
        {
            int col = 0;
            foreach (var key in data[0].Keys)
            {
                // Lägg till rubrik med stil
                Cell cell = sheet.Cells[0, col];
                cell.PutValue(key);
                
                Style style = cell.GetStyle();
                style.Font.IsBold = true;
                cell.SetStyle(style);
                
                col++;
            }
            
            // Lägg till datarader
            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++;
                }
            }
        }
        
        // Formatera som en tabell
        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");
        }
        
        // Autofit kolumner
        sheet.AutoFitColumns();
        
        // Spara arbetsboken
        workbook.Save(outputPath);
    }
}

Steg 6: Lägg till professionell formatering

Förbättra Excel-utdata med professionell styling:

public void ApplyProfessionalFormatting(Workbook workbook)
{
    Worksheet sheet = workbook.Worksheets[0];
    
    // Skapa en stil för titeln
    Style titleStyle = workbook.CreateStyle();
    titleStyle.Font.Size = 14;
    titleStyle.Font.IsBold = true;
    titleStyle.HorizontalAlignment = TextAlignmentType.Center;
    
    // Lägg till en titel till rapporten
    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);
    
    // Infoga en tom rad efter titeln
    sheet.Cells.InsertRow(1);
    
    // Tillämpa växelvis radfärger på datan
    Style evenRowStyle = workbook.CreateStyle();
    evenRowStyle.ForegroundColor = Color.FromArgb(240, 240, 240);
    evenRowStyle.Pattern = BackgroundType.Solid;
    
    int dataStartRow = 3; // Tar hänsyn till titel och tom rad
    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);
        }
    }
    
    // Lägg till sidhuvud och sidfot
    sheet.PageSetup.SetHeader(1, "&\"Arial,Bold\"&14API Report");
    sheet.PageSetup.SetFooter(1, "Sid &P av &N");
    
    // Ställ in utskriftsalternativ
    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;
}

Steg 7: Lägg till datavisualisering

Förbättra rapporten med diagram:

public void AddChartVisualization(Workbook workbook, int dataColumn)
{
    Worksheet sheet = workbook.Worksheets[0];
    Worksheet chartSheet = workbook.Worksheets.Add("Diagramanalys");
    
    // Hämta dataintervallet (hoppa över rubrikraden)
    int lastRow = sheet.Cells.MaxRow;
    int nameColumn = 0; // Anta att första kolumnen har namn/kategorier
    
    // Lägg till ett diagram
    int chartIndex = chartSheet.Charts.Add(ChartType.Column, 2, 2, 20, 10);
    Chart chart = chartSheet.Charts[chartIndex];
    
    // Ställ in dataintervallet för diagrammet
    chart.NSeries.Add($"Sheet1!B2:B{lastRow + 1}", true);
    chart.NSeries.CategoryData = $"Sheet1!A2:A{lastRow + 1}";
    
    // Ställ in diagramtitel och andra egenskaper
    chart.Title.Text = "Dataanalys";
    chart.Legend.Position = LegendPositionType.Bottom;
    
    // Ytterligare diagramanpassning
    chart.NSeries[0].Area.ForegroundColor = Color.FromArgb(79, 129, 189);
    chart.PlotArea.Area.ForegroundColor = Color.White;
    
    // Lägg till datalabels
    chart.NSeries[0].DataLabels.IsValueShown = true;
    chart.NSeries[0].DataLabels.Position = DataLabelPositionType.OutsideEnd;
}

Steg 8: Sätt ihop allt

Skapa huvudprogrammet som knyter ihop allt:

using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        try
        {
            // Konfigurera API-slutpunkt
            string baseUrl = "https://api.example.com";
            string endpoint = "/data/endpoint";
            string apiKey = "your-api-key"; // Om det behövs
            
            // Anslut till API och hämta data
            Console.WriteLine("Ansluter till API...");
            var apiService = new ApiService(baseUrl);
            var jsonData = await apiService.GetApiDataAsync<string>(endpoint, apiKey);
            
            Console.WriteLine("Data hämtades framgångsrikt");
            
            // Generera Excel-rapport
            Console.WriteLine("Genererar Excel-rapport...");
            var reportGenerator = new ExcelReportGenerator();
            
            // Alternativ 1: Direkt JSON till Excel-konvertering
            string outputPath = "ApiReport_" + DateTime.Now.ToString("yyyyMMdd_HHmmss") + ".xlsx";
            reportGenerator.GenerateReport(jsonData, outputPath);
            
            // Alternativ 2: Bearbeta JSON och skapa förbättrad rapport
            // var processor = new DataProcessor();
            // var processedData = processor.FlattenJsonData(jsonData);
            // reportGenerator.GenerateReportFromObjects(processedData, outputPath);
            
            Console.WriteLine($"Rapport sparad till {outputPath}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Fel: {ex.Message}");
        }
    }
}

Hantera olika API-svarstrukturer

REST API:er returnerar data i olika format. Här är hur man hanterar vanliga strukturer:

1. Array av objekt

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

För denna struktur, använd:

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

2. Nästlad objekt med data-array

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

Använd DataProcessor-klassen för att extrahera “data”-arrayen, eller:

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

// Konvertera till sträng och importera
string dataArrayJson = dataArray.ToString();
JsonUtility.ImportData(dataArrayJson, sheet.Cells, 0, 0, options);

3. Nästlade arrayer och objekt

{
  "categories": [
    {
      "name": "Elektronik",
      "products": [
        { "id": 1, "name": "Bärbar dator", "price": 999.99 },
        { "id": 2, "name": "Telefon", "price": 699.99 }
      ]
    },
    {
      "name": "Böcker",
      "products": [
        { "id": 3, "name": "Roman", "price": 14.99 }
      ]
    }
  ]
}

För komplexa strukturer, skapa flera kalkylblad:

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

// Skapa ett kalkylblad för varje kategori
foreach (var category in categories)
{
    string categoryName = category["name"].ToString();
    Worksheet sheet = workbook.Worksheets.Add(categoryName);
    
    // Hämta och importera produkter-arrayen
    JArray products = (JArray)category["products"];
    JsonUtility.ImportData(products.ToString(), sheet.Cells, 0, 0, options);
}

Ta det till nästa nivå: Schemalagda rapporter

För att automatisera rapportgenerering, lägg till schemaläggningsfunktioner:

// Installera Task Scheduler-paket
// dotnet add package TaskScheduler

using Microsoft.Win32.TaskScheduler;

public void ScheduleDailyReportGeneration(string appPath)
{
    using (TaskService ts = new TaskService())
    {
        // Skapa en ny uppgift
        TaskDefinition td = ts.NewTask();
        td.RegistrationInfo.Description = "Daglig API Data Rapportgenerering";
        
        // Skapa en trigger som kommer att aktiveras dagligen klockan 7
        td.Triggers.Add(new DailyTrigger { StartBoundary = DateTime.Today.AddHours(7) });
        
        // Skapa en åtgärd som kommer att köra applikationen
        td.Actions.Add(new ExecAction(appPath));
        
        // Registrera uppgiften i rotmappen
        ts.RootFolder.RegisterTaskDefinition("DailyApiReport", td);
    }
}

Avancerade funktioner att överväga

E-postleverans - Skicka automatiskt rapporter via e-post
Multi-API-integration - Kombinera data från flera API:er
Mallbaserade rapporter - Använd Excel-mallar för konsekvent varumärkesprofilering
Skapa instrumentpaneler - Generera interaktiva Excel-instrumentpaneler
Felkoll och rapportering - Logga problem och rapportera om framgång/misslyckande

Genom att följa denna guide har du skapat en robust C#-applikation som automatiserar processen att hämta API-data och konvertera den till professionella Excel-rapporter—spara tid, säkerställa noggrannhet och leverera affärsvärde.