Como Transformar Respostas de API em Relatórios Excel em C#

No mundo orientado a dados de hoje, as empresas dependem fortemente de APIs REST para troca de dados. No entanto, muitos interessados preferem consumir esses dados no formato Excel para análise e relatórios. Este guia demonstra como construir um aplicativo C# completo que:

Conecta-se a APIs REST
Recupera dados de resposta em JSON
Converte os dados em relatórios Excel formatados profissionalmente
Adiciona visualização com gráficos e tabelas

Valor Comercial

Esta solução oferece um valor significativo ao:

Automatizar processos manuais de extração de dados e criação de relatórios
Garantir a precisão dos dados ao eliminar cópias manuais
Proporcionar formatação consistente de relatórios
Permitir geração de relatórios agendados

Guia de Implementação Passo a Passo

Passo 1: Criar um Novo Aplicativo C#

Comece criando um novo aplicativo de console:

dotnet new console -n ApiToExcelReporter
cd ApiToExcelReporter

Passo 2: Instalar Pacotes Necessários

Adicione os pacotes NuGet necessários:

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

Passo 3: Implementar o Cliente da API REST

Crie um serviço para comunicação com a 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);
        
        // Adicione autenticação se necessário
        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($"A chamada da API falhou: {response.ErrorMessage}");
    }
}

Passo 4: Processar Dados de Resposta em JSON

Adicione uma classe para processar os dados 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);
        
        // Manipular diferentes estruturas JSON
        if (token is JArray array)
        {
            foreach (var item in array)
            {
                results.Add(FlattenObject(item));
            }
        }
        else if (token is JObject obj)
        {
            // Para dados aninhados como {"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;
        }
    }
}

Passo 5: Converter para Excel com Aspose.Cells

Implemente a conversão para 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)
    {
        // Crie uma nova pasta de trabalho
        Workbook workbook = new Workbook();
        Worksheet sheet = workbook.Worksheets[0];
        
        // Configure opções de layout JSON
        JsonLayoutOptions options = new JsonLayoutOptions
        {
            ArrayAsTable = true,
            ConvertNumericOrDate = true,
            IgnoreNull = true
        };
        
        // Torne os cabeçalhos em negrito
        options.TitleStyle = new CellsFactory().CreateStyle();
        options.TitleStyle.Font.IsBold = true;
        
        // Importar dados JSON
        JsonUtility.ImportData(jsonData, sheet.Cells, 0, 0, options);
        
        // Ajustar automaticamente as colunas
        sheet.AutoFitColumns();
        
        // Salvar a pasta de trabalho
        workbook.Save(outputPath);
    }
    
    public void GenerateReportFromObjects(List<Dictionary<string, object>> data, string outputPath)
    {
        Workbook workbook = new Workbook();
        Worksheet sheet = workbook.Worksheets[0];
        
        // Adicionar cabeçalhos se houver dados
        if (data.Count > 0)
        {
            int col = 0;
            foreach (var key in data[0].Keys)
            {
                // Adicionar cabeçalho com estilo
                Cell cell = sheet.Cells[0, col];
                cell.PutValue(key);
                
                Style style = cell.GetStyle();
                style.Font.IsBold = true;
                cell.SetStyle(style);
                
                col++;
            }
            
            // Adicionar linhas de dados
            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á-lo como uma tabela
        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");
        }
        
        // Ajustar automaticamente as colunas
        sheet.AutoFitColumns();
        
        // Salvar a pasta de trabalho
        workbook.Save(outputPath);
    }
}

Passo 6: Adicionar Formatação Profissional

Aprimore a saída do Excel com estilo profissional:

public void ApplyProfessionalFormatting(Workbook workbook)
{
    Worksheet sheet = workbook.Worksheets[0];
    
    // Crie um estilo para o título
    Style titleStyle = workbook.CreateStyle();
    titleStyle.Font.Size = 14;
    titleStyle.Font.IsBold = true;
    titleStyle.HorizontalAlignment = TextAlignmentType.Center;
    
    // Adicione um título ao relatório
    sheet.Cells.Merge(0, 0, 1, sheet.Cells.MaxColumn + 1);
    Cell titleCell = sheet.Cells[0, 0];
    titleCell.PutValue("Relatório de Dados da API - " + DateTime.Now.ToString("yyyy-MM-dd"));
    titleCell.SetStyle(titleStyle);
    
    // Insira uma linha em branco após o título
    sheet.Cells.InsertRow(1);
    
    // Aplique cores alternadas às linhas dos dados
    Style evenRowStyle = workbook.CreateStyle();
    evenRowStyle.ForegroundColor = Color.FromArgb(240, 240, 240);
    evenRowStyle.Pattern = BackgroundType.Solid;
    
    int dataStartRow = 3; // Contabilizando título e linha em branco
    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);
        }
    }
    
    // Adicionar cabeçalho e rodapé da página
    sheet.PageSetup.SetHeader(1, "&\"Arial,Bold\"&14Relatório da API");
    sheet.PageSetup.SetFooter(1, "Página &P de &N");
    
    // Definir opções de impressão
    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;
}

Passo 7: Adicionar Visualização de Dados

Aprimore o relatório com gráficos:

public void AddChartVisualization(Workbook workbook, int dataColumn)
{
    Worksheet sheet = workbook.Worksheets[0];
    Worksheet chartSheet = workbook.Worksheets.Add("Análise de Gráficos");
    
    // Obter o intervalo de dados (pule a linha do cabeçalho)
    int lastRow = sheet.Cells.MaxRow;
    int nameColumn = 0; // Supondo que a primeira coluna tenha nomes/categorias
    
    // Adicionar um gráfico
    int chartIndex = chartSheet.Charts.Add(ChartType.Column, 2, 2, 20, 10);
    Chart chart = chartSheet.Charts[chartIndex];
    
    // Definir o intervalo de dados para o gráfico
    chart.NSeries.Add($"Sheet1!B2:B{lastRow + 1}", true);
    chart.NSeries.CategoryData = $"Sheet1!A2:A{lastRow + 1}";
    
    // Definir título do gráfico e outras propriedades
    chart.Title.Text = "Análise de Dados";
    chart.Legend.Position = LegendPositionType.Bottom;
    
    // Personalização adicional do gráfico
    chart.NSeries[0].Area.ForegroundColor = Color.FromArgb(79, 129, 189);
    chart.PlotArea.Area.ForegroundColor = Color.White;
    
    // Adicionar rótulos de dados
    chart.NSeries[0].DataLabels.IsValueShown = true;
    chart.NSeries[0].DataLabels.Position = DataLabelPositionType.OutsideEnd;
}

Passo 8: Juntar Tudo

Crie o programa principal que une tudo:

using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        try
        {
            // Configurar o endpoint da API
            string baseUrl = "https://api.example.com";
            string endpoint = "/data/endpoint";
            string apiKey = "sua-chave-api"; // Se necessário
            
            // Conectar à API e obter dados
            Console.WriteLine("Conectando à API...");
            var apiService = new ApiService(baseUrl);
            var jsonData = await apiService.GetApiDataAsync<string>(endpoint, apiKey);
            
            Console.WriteLine("Dados recuperados com sucesso");
            
            // Gerar relatório Excel
            Console.WriteLine("Gerando relatório Excel...");
            var reportGenerator = new ExcelReportGenerator();
            
            // Opção 1: Conversão direta de JSON para Excel
            string outputPath = "ApiReport_" + DateTime.Now.ToString("yyyyMMdd_HHmmss") + ".xlsx";
            reportGenerator.GenerateReport(jsonData, outputPath);
            
            // Opção 2: Processar JSON e criar relatório aprimorado
            // var processor = new DataProcessor();
            // var processedData = processor.FlattenJsonData(jsonData);
            // reportGenerator.GenerateReportFromObjects(processedData, outputPath);
            
            Console.WriteLine($"Relatório salvo em {outputPath}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Erro: {ex.Message}");
        }
    }
}

Lidando com Diferentes Estruturas de Resposta da API

APIs REST retornam dados em vários formatos. Aqui está como lidar com estruturas comuns:

1. Array de Objetos

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

Para esta estrutura, use:

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

2. Objeto Aninhado com Array de Dados

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

Use a classe DataProcessor para extrair o array “data”, ou:

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

// Converter para string e importar
string dataArrayJson = dataArray.ToString();
JsonUtility.ImportData(dataArrayJson, sheet.Cells, 0, 0, options);

3. Arrays e Objetos Aninhados

{
  "categories": [
    {
      "name": "Eletrônicos",
      "products": [
        { "id": 1, "name": "Laptop", "price": 999.99 },
        { "id": 2, "name": "Telefone", "price": 699.99 }
      ]
    },
    {
      "name": "Livros",
      "products": [
        { "id": 3, "name": "Romance", "price": 14.99 }
      ]
    }
  ]
}

Para estruturas complexas, crie várias planilhas:

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

// Criar uma planilha para cada categoria
foreach (var category in categories)
{
    string categoryName = category["name"].ToString();
    Worksheet sheet = workbook.Worksheets.Add(categoryName);
    
    // Obter e importar o array de produtos
    JArray products = (JArray)category["products"];
    JsonUtility.ImportData(products.ToString(), sheet.Cells, 0, 0, options);
}

Levando Para o Próximo Nível: Relatórios Agendados

Para automatizar a geração de relatórios, adicione recursos de agendamento:

// Instalar pacote Task Scheduler
// dotnet add package TaskScheduler

using Microsoft.Win32.TaskScheduler;

public void ScheduleDailyReportGeneration(string appPath)
{
    using (TaskService ts = new TaskService())
    {
        // Criar uma nova tarefa
        TaskDefinition td = ts.NewTask();
        td.RegistrationInfo.Description = "Geração Diária de Relatório de Dados da API";
        
        // Criar um gatilho que será ativado diariamente às 7h
        td.Triggers.Add(new DailyTrigger { StartBoundary = DateTime.Today.AddHours(7) });
        
        // Criar uma ação que executará o aplicativo
        td.Actions.Add(new ExecAction(appPath));
        
        // Registrar a tarefa na pasta raiz
        ts.RootFolder.RegisterTaskDefinition("RelatórioDiárioApi", td);
    }
}

Recursos Avançados a Considerar

Entrega por e-mail - Enviar relatórios automaticamente por e-mail
Integração de múltiplas APIs - Combinar dados de várias APIs
Relatórios baseados em template - Usar templates do Excel para branding consistente
Criação de dashboard - Gerar dashboards interativos em Excel
Rastreamento e relatório de erros - Registrar problemas e relatar sucesso/falha

Seguindo este guia, você criou um aplicativo C# robusto que automatiza o processo de recuperação de dados da API e conversão em relatórios Excel profissionais—economizando tempo, garantindo precisão e entregando valor comercial.