Як перетворити відповіді API на звіти Excel у C#

У сучасному світі, орієнтованому на дані, бізнеси значною мірою покладаються на REST API для обміну даними. Однак багато зацікавлених сторін надають перевагу споживанню цих даних у форматі Excel для аналізу та звітності. Цей посібник демонструє, як побудувати повну C# програму, яка:

Підключається до REST API
Отримує дані у форматі JSON
Конвертує дані у професійно оформлені звіти Excel
Додає візуалізацію за допомогою графіків і таблиць

Бізнес-цінність

Це рішення надає значну цінність, автоматизуючи процеси ручного витягування даних і створення звітів, забезпечуючи точність даних шляхом усунення ручного копіювання, надаючи узгоджене форматування звітів і можливість планового генерування звітів.

Покроковий посібник з реалізації

Крок 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: Конвертуйте в Excel за допомогою Aspose.Cells

Реалізуйте конвертацію 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 Report");
    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": "Продукт A", "price": 29.99 },
  { "id": 2, "name": "Продукт 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": "Продукт A", "price": 29.99 },
    { "id": 2, "name": "Продукт 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": "Електроніка",
      "products": [
        { "id": 1, "name": "Ноутбук", "price": 999.99 },
        { "id": 2, "name": "Телефон", "price": 699.99 }
      ]
    },
    {
      "name": "Книги",
      "products": [
        { "id": 3, "name": "Роман", "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);
}

Виведення на новий рівень: Заплановані звіти

Щоб автоматизувати генерацію звітів, додайте можливості планування:

// Встановіть пакет Task Scheduler
// 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);
    }
}

Розширені функції, які варто врахувати

Доставка електронною поштою - Автоматично надсилайте звіти електронною поштою
Інтеграція з кількома API - Об’єднуйте дані з кількох API
Звіти на основі шаблонів - Використовуйте шаблони Excel для узгодженого брендингу
Створення панелей управління - Генеруйте інтерактивні панелі управління Excel
Відстеження помилок і звітування - Логуйте проблеми та звітуйте про успіх/невдачу

Дотримуючись цього посібника, ви створили надійну C# програму, яка автоматизує процес отримання даних API та конвертації їх у професійні звіти Excel, економлячи час, забезпечуючи точність і надаючи бізнес-цінність.