將其整合到 ASP.NET Core 網路應用程式中,可實現於您的網站入口直接進行無縫的文件編輯。GroupDocs.Editor Cloud SDK for .NET 提供強大的 API,讓您能在伺服器上載入、編輯並儲存 DOCX 檔案。本指南將帶您完成必要的設定步驟,展示逐步程式碼,並提供完整範例,您可在數分鐘內執行。完成後,您將能自信地將文件編輯功能加入 ASP.NET Core 應用程式。
先決條件與設定
在開始之前,請確保您具備以下條件:
- .NET 6.0 SDK 或更新版本已安裝
- 如 Visual Studio 2022 或 VS Code 等 IDE
- 一個 GroupDocs Cloud 帳戶以取得 Client Id 和 Client Secret
- 可使用 Windows、Linux 或 macOS 開發機器
將其整合到 ASP.NET Core 網路應用程式中也需要可靠的網路連線至 GroupDocs Cloud 端點,因為所有文件處理都是遠端進行的。請相應地規劃您的部署環境。
透過 NuGet 安裝 SDK:
dotnet add package GroupDocs.editor-Cloud
從官方發布頁面下載最新套件: GroupDocs.Editor Cloud SDK for .NET Download.
使用您的憑證建立配置物件(摘自完整範例):
var configuration = new Configuration
{
ClientId = "client_id",
ClientSecret = "client_secret"
};
安裝好套件並準備好憑證後,您可以繼續實作。接下來的章節會詳細說明每段程式碼,讓您了解此函式庫如何融入 ASP.NET Core 網頁應用程式的整體架構。
步驟指南:將其整合到 ASP.NET Core Web 應用程式中
本節將把在 ASP.NET Core 網路應用程式中整合的過程分解為離散且易於管理的步驟。每個步驟都包含直接取自參考實作的簡短程式碼片段。
步驟 1:配置 API 憑證
首先,使用您的客戶端詳細資訊實例化 Configuration 物件,並建立 EditorApi 客戶端。
var configuration = new Configuration
{
ClientId = "client_id",
ClientSecret = "client_secret"
};
var editorApi = new EditorApi(configuration);
EditorApi 類別的文件位於 API 參考。在大多數情況下,每個請求初始化一次客戶端就足夠;您也可以將其註冊為單例,放入 ASP.NET Core 依賴注入容器,以獲得更好的效能。
步驟 2:定義載入選項
使用 LoadOptions 指定來源檔案和所需的輸出位置。此物件告訴服務要開啟哪個文件以及將渲染的 HTML 存放在哪裡。
var loadOptions = new LoadOptions
{
FileInfo = new FileInfo { FilePath = "input.docx" },
RenderOptions = new RenderOptions { OutputPath = "output.html" }
};
LoadOptions、FileInfo 和 RenderOptions 讓您可以控制文件在編輯時的渲染方式。例如,您可以設定 RenderOptions 以包含圖像、保留原始樣式,或限制渲染的頁數。
步驟 3:呼叫 LoadDocument
呼叫 API 以載入並轉換文件。此範例中的呼叫是同步的,但如果您的控制器動作是非同步的,也可以使用非同步版本。
var loadResult = editorApi.LoadDocument(loadOptions);
LoadDocument 方法返回一个包含渲染后 HTML URL 以及其他元数据的结果对象。您可以将 loadResult 存储以便稍后检索,或直接将 HTML 传递给前端。
步驟 4:處理載入結果
載入後,您可以將 HTML 提供給前端或儲存以供稍後使用。此步驟完成 將文件編輯器整合到 ASP.NET Core 網頁應用程式 工作流程,並為使用者互動做好文件的準備。
在實際情況中,您通常會從控制器操作返回 HTML 內容:
return Content(loadResult.HtmlContent, "text/html");
您可能也想實作快取,以避免重複重新載入相同的文件,這可以在大規模 將 ASP.NET Core 網頁應用程式整合 時提升回應時間。
將文件編輯器整合到 ASP.NET Core Web 應用程式 - 完整程式碼範例
以下程式碼示範了從配置到載入 DOCX 檔案的完整流程。
var configuration = new Configuration
{
ClientId = "client_id",
ClientSecret = "client_secret"
};
var editorApi = new EditorApi(configuration);
var loadOptions = new LoadOptions
{
FileInfo = new FileInfo { FilePath = "input.docx" },
RenderOptions = new RenderOptions { OutputPath = "output.html" }
};
var loadResult = editorApi.LoadDocument(loadOptions);
注意: 此程式碼範例展示了核心功能。 在將其用於您的專案之前,請確保更新所有檔案路徑和設定值以符合實際環境,驗證所有必要的相依項目已正確安裝,並在開發環境中徹底測試。 如果遇到任何問題,請參閱官方文件或聯繫支援團隊以獲得協助。
使用 cURL 進行 ASP.NET Core 文件編輯整合
如果您偏好直接的 REST 方法,可以使用 cURL 命令執行相同的操作。此方法對於快速原型設計或在需要將編輯器整合到非 .NET 撰寫的服務時非常有用。
1. 驗證並取得存取權杖
curl -X POST "https://api.groupdocs.cloud/v2.0/auth/token" \
-H "Content-Type: application/json" \
-d '{"client_id":"YOUR_CLIENT_ID","client_secret":"YOUR_CLIENT_SECRET"}'
回應中包含一個在後續呼叫中使用的 access_token。
2. 上傳來源檔案
curl -X POST "https://api.groupdocs.cloud/v2.0/editor/storage/upload?path=/input.docx" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-F "file=@input.docx"
3. 載入文件以進行編輯
curl -X POST "https://api.groupdocs.cloud/v2.0/editor/load" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"fileInfo": { "filePath": "input.docx" },
"renderOptions": { "outputPath": "output.html" }
}'
4. 下載已渲染的 HTML
curl -X GET "https://api.groupdocs.cloud/v2.0/editor/storage/download?path=/output.html" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-o output.html
以下指令示範如何 將文件編輯功能加入 ASP.NET Core 應用程式,且無需撰寫任何 C# 程式碼,適用於快速測試或與其他服務整合。欲了解更多資訊,請參閱 官方 API 文件。
通過精通 .NET 庫和原始 REST API,您在 整合到 ASP.NET Core Web 應用程式 時獲得靈活性,從而可以選擇最適合您架構的方法。
