使用英语阅读

通过

调用 Web API 的 Web 应用：调用 Web API

  • 项目
  • 2024/11/12

现在你已有令牌，可以调用受保护的 Web API 了。 通常从 Web 应用的控制器或页面调用下游 API。

调用受保护的 Web API

调用受保护的 Web API 取决于所选的语言和框架：

使用 Microsoft.Identity.Web 时，有三个用于调用 API 的使用选项：

选项 1：使用 SDK 从 OWIN 应用调用 Microsoft Graph

你要调用 Microsoft Graph。 在此方案中，你已按代码配置中的指定将AddMicrosoftGraph添加到Startup.cs 中，现可通过使用控制器上的GetGraphServiceClient()扩展方法在控制器或页构造函数中获取GraphServiceClient，以便在操作中使用。 以下示例显示已登录用户的照片。

[Authorize]
[AuthorizeForScopes(Scopes = new[] { "https://microsoftgraph.chinacloudapi.cn/user.read" })]
public class HomeController : Controller
{

 public async Task GetIndex()
 {
  var graphServiceClient = this.GetGraphServiceClient();
  var user = await graphServiceClient.Me.GetAsync();
  try
  {
   using (var photoStream = await graphServiceClient.Me.Photo.Content.GetAsync())
   {
    byte[] photoByte = ((MemoryStream)photoStream).ToArray();
    ViewData["photo"] = Convert.ToBase64String(photoByte);
   }
   ViewData["name"] = user.DisplayName;
  }
  catch (Exception)
  {
   ViewData["photo"] = null;
  }
 }
}

有关完整示例，请参阅调用 Microsoft Graph 的 ASP.NET OWIN Web 应用

选项 2：使用帮助程序类从 OWIN 应用调用下游 Web API

你想要调用 Microsoft Graph 以外的 Web API。 在此方案中，你已按代码配置中的指定将AddDownstreamApi添加到Startup.cs中，现可通过调用控制器上的GetDownstreamApi扩展方法在控制器中获取IDownstreamApi服务：

[Authorize]
public class TodoListController : Controller
{ 
  public async Task<ActionResult> Details(int id)
  {
    var downstreamApi = this.GetDownstreamApi();
    var value = await downstreamApi.CallApiForUserAsync(
      ServiceName,
      options =>
      {
        options.RelativePath = $"me";
      });
      return View(value);
  }
}

CallApiForUserAsync 还具有强类型的泛型重写，使你能够直接接收对象。 例如，下面的方法收到一个 Todo 实例，该实例是 Web API 返回的 JSON 的强类型表示形式。

    // GET: TodoList/Details/5
    public async Task<ActionResult> Details(int id)
    {
        var downstreamApi = this.GetDownstreamApi();
        var value = await downstreamApi.CallApiForUserAsync<object, Todo>(
            ServiceName,
            null,
            options =>
            {
                options.HttpMethod = HttpMethod.Get;
                options.RelativePath = $"api/todolist/{id}";
            });
        return View(value);
    }

选项 3：在不使用帮助程序类的情况下从 OWIN 应用调用下游 Web API

你已决定使用 IAuthorizationHeaderProvider 服务获取授权标头，现在需要在 HttpClient 或 HttpRequest 中使用它。 在这种情况下，以下代码继续演示调用 Web API 的 Web 应用：获取应用的令牌中显示的示例代码。 该代码将在 Web 应用控制器的操作中调用。

public async Task<IActionResult> Profile()
{
  // Acquire the access token.
  string[] scopes = new string[]{"https://microsoftgraph.chinacloudapi.cn/user.read"};
  var IAuthorizationHeaderProvider = this.GetAuthorizationHeaderProvider();
  string authorizationHeader = await IAuthorizationHeaderProvider.GetAuthorizationHeaderForUserAsync(scopes);

  // Use the access token to call a protected web API.
  HttpClient httpClient = new HttpClient();
  client.DefaultRequestHeaders.Add("Authorization", authorizationHeader);

  var response = await httpClient.GetAsync($"{webOptions.GraphApiUrl}/beta/me");

  if (response.StatusCode == HttpStatusCode.OK)
  {
    var content = await response.Content.ReadAsStringAsync();

    dynamic me = JsonConvert.DeserializeObject(content);
    ViewData["Me"] = me;
  }

  return View();
}

后续步骤

  • 通过在以下多部分教程系列中生成可用户登录的 ASP.NET Core Web 应用来了解详细信息

  • 浏览 Microsoft 标识平台 Web 应用示例