Как преобразовать ответы 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 Отчет");
    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 = "ваш-api-ключ"; // Если необходимо
            
            // Подключитесь к 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("ЕжедневныйApiReport", td);
    }
}

Расширенные функции, которые стоит рассмотреть

Доставка по электронной почте - Автоматическая отправка отчетов по электронной почте
Интеграция нескольких API - Объединение данных из нескольких API
Отчеты на основе шаблонов - Использование шаблонов Excel для последовательного брендинга
Создание панели управления - Генерация интерактивных панелей управления Excel
Отслеживание и отчетность об ошибках - Ведение журнала проблем и отчетность о успехе/неудаче

Следуя этому руководству, вы создали надежное приложение на C#, которое автоматизирует процесс извлечения данных API и преобразования их в профессиональные отчеты Excel, экономя время, обеспечивая точность и принося бизнес-ценность.