C#에서 API 응답을 Excel 보고서로 변환하는 방법
C#에서 API 응답을 Excel 보고서로 변환하는 방법
오늘날의 데이터 기반 세계에서 비즈니스는 데이터 교환을위한 REST APIs에 크게 의존합니다.그러나 많은 이해 관계자는 분석 및 보고를 위해 Excel 형식으로이 데이터를 소비하는 것을 선호합니다.이 가이드는 완전한 C# 응용 프로그램을 구축하는 방법을 보여줍니다.
- 나머지 APIs에 연결
- 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);
// 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}");
}
}
단계 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);
// 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;
}
}
}
단계 5: Aspose.Cells를 사용하여 Excel로 변환
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);
}
}
단계 6 : 전문 형식을 추가
전문 스타일링으로 Excel 출력을 향상시킵니다 :
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;
}
단계 7 : 데이터 시각화 추가
차트로 보고서를 개선하십시오 :
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;
}
단계 8 : 모든 것을 함께 넣으십시오
모든 것을 연결하는 주요 프로그램을 만드십시오 :
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}");
}
}
}
다른 API 응답 구조를 처리
REST APIs는 다양한 형식으로 데이터를 반환합니다.이것은 일반 구조를 처리하는 방법입니다 :
1) 개체의 범위
[
{ "id": 1, "name": "Product A", "price": 29.99 },
{ "id": 2, "name": "Product B", "price": 49.99 }
]
이 구조를 위해, 사용하십시오 :
JsonLayoutOptions options = new JsonLayoutOptions();
options.ArrayAsTable = true;
JsonUtility.ImportData(jsonData, sheet.Cells, 0, 0, options);
2.Data Array를 가진 Nested Object
{
"status": "success",
"data": [
{ "id": 1, "name": "Product A", "price": 29.99 },
{ "id": 2, "name": "Product B", "price": 49.99 }
]
}
데이터 프로세서 클래스를 사용하여 “데이터"열을 추출하거나:
// 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) 망가진 물건과 물건
{
"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 }
]
}
]
}
복잡한 구조를 위해 여러 워크시트를 만드십시오 :
// 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);
}
다음 단계로 가져 가기 : 일정 보고서
보고서 생성을 자동화하려면 일정 기능을 추가하십시오 :
// 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);
}
}
고려해야 할 고급 기능
- 이메일 배달 - 이메일로 보고서를 자동으로 보내기
- Multi-API 통합 - 여러 API에서 데이터를 결합
- 템플릿 기반 보고서 - 일관된 브랜드를 위해 Excel 템플릿을 사용하십시오.
- Dashboard Creation - 인터랙티브 Excel 다쉬보드를 생성
- 오류 추적 및 보고 - 기록 문제 및 성공/실패 보고서
이 가이드를 따르면서 API 데이터를 복구하고 전문 Excel 보고서로 변환하는 과정을 자동화하는 강력한 C# 응용 프로그램을 만들었습니다 - 시간을 절약하고 정확성을 보장하고 비즈니스 가치를 제공합니다.