.NET Core WebAPI实现Office文档桌面客户端远程保存方案咨询

要解决Office桌面端编辑后直接保存回API的问题，无需搭建完整WebDAV服务器，只需实现Office保存时依赖的WebDAV最小核心接口即可。以下是具体实现步骤：

核心思路 #

Office桌面端打开远程URL的文档后，保存时会自动向原URL发送WebDAV标准请求（主要是OPTIONS、PUT、HEAD）。我们只需在API中处理这几个关键请求，就能让Office完成自动保存。

具体实现代码 #

1. 文档控制器基础结构 #

创建一个处理文档读写的控制器，包含文件路径逻辑：

[ApiController]
[Route("api/documents")]
public class DocumentsController : ControllerBase
{
    // 替换为你的实际文件存储路径逻辑
    private string GetFilePath(string documentId)
    {
        return Path.Combine("YourServerStoragePath", $"{documentId}.docx");
    }
}

2. 处理OPTIONS请求（告知Office支持WebDAV） #

Office会先发送OPTIONS请求验证端点权限，需返回允许的方法和DAV版本头：

[HttpOptions("{documentId}")]
public IActionResult Options(string documentId)
{
    Response.Headers.Add("Allow", "OPTIONS, GET, HEAD, PUT");
    Response.Headers.Add("DAV", "1, 2"); // 标识端点支持WebDAV核心功能
    return Ok();
}

3. 实现GET端点（文件下载逻辑） #

保持你现有的文件返回逻辑，确保Content-Type与Office文档类型匹配：

[HttpGet("{documentId}")]
public IActionResult GetDocument(string documentId)
{
    var filePath = GetFilePath(documentId);
    if (!System.IO.File.Exists(filePath))
        return NotFound();

    // 根据文档类型设置正确的Content-Type
    return PhysicalFile(
        filePath, 
        "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
        enableRangeProcessing: true // 支持断点续传，优化Office打开体验
    );
}

4. 实现PUT端点（接收Office保存的文件） #

处理Office发送的文件流，覆盖或更新服务器上的文档：

[HttpPut("{documentId}")]
public async Task<IActionResult> PutDocument(string documentId)
{
    var filePath = GetFilePath(documentId);
    using var outputStream = new FileStream(filePath, FileMode.Create, FileAccess.Write);
    await Request.Body.CopyToAsync(outputStream);
    return Ok();
}

5. 可选：实现HEAD请求（支持文件版本校验） #

返回文件的修改时间和ETag，让Office能检测文件冲突：

[HttpHead("{documentId}")]
public IActionResult HeadDocument(string documentId)
{
    var filePath = GetFilePath(documentId);
    if (!System.IO.File.Exists(filePath))
        return NotFound();

    var fileInfo = new FileInfo(filePath);
    Response.Headers.Add("Last-Modified", fileInfo.LastWriteTimeUtc.ToString("R"));
    Response.Headers.Add("ETag", $"\"{fileInfo.LastWriteTimeUtc.Ticks:x}\"");
    return Ok();
}

关键配置与注意事项 #

• Office打开URL：使用Office URI Schema时，直接指向你的GET/PUT端点，例如：

  ms-word:ofe|u|https://your-api-domain/api/documents/123
  

  这样Office保存时会自动向该URL发送PUT请求。

• 身份验证：如果API有身份验证，需确保Office桌面端能传递凭证：

  • 内部系统可使用Windows身份验证，Office会自动复用当前用户凭证；
  • 若用Bearer Token，需在URL中附加临时有效令牌（注意令牌有效期），或配置Office使用OAuth（较复杂）。

• CORS设置：在Program.cs中配置CORS，允许Office桌面端的请求：

  builder.Services.AddCors(options =>
  {
      options.AddPolicy("OfficeSavePolicy", policy =>
      {
          policy.AllowAnyOrigin() // 生产环境需限制为可信来源
                .AllowAnyHeader()
                .AllowAnyMethod();
      });
  });
  
  app.UseCors("OfficeSavePolicy");
  

• Content-Type匹配：不同Office文档对应不同的Content-Type，例如：

  • Excel (.xlsx)：application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • PowerPoint (.pptx)：application/vnd.openxmlformats-officedocument.presentationml.presentation

内容的提问来源于stack exchange，提问作者Lucas Minatal