如何从.NET Web API执行AWS AppSync中已部署的GraphQL查询并获取响应结果

嘿，我刚好做过类似的实现，给你详细梳理下从.NET Web API调用AWS AppSync GraphQL查询的具体步骤，亲测好用！

一、前期准备 #

先确认你手头有这些信息：

• 已部署好的AWS AppSync API的端点URL
• AppSync的认证凭证（这里先以API密钥为例，这是最简单的认证方式，后面会提其他方式）
• 你的.NET Web API项目是基于.NET Core/.NET 5+版本的（现在主流项目都用这个）

二、安装必要的NuGet包 #

我们可以用专门的GraphQL客户端库来简化调用，比直接用HttpClient写请求更省心：
在Package Manager Console里执行：

Install-Package GraphQL.Client
Install-Package GraphQL.Client.Serializer.Newtonsoft

或者用.NET CLI命令：

dotnet add package GraphQL.Client
dotnet add package GraphQL.Client.Serializer.Newtonsoft

如果你项目用的是System.Text.Json而不是Newtonsoft.Json，就换成GraphQL.Client.Serializer.SystemTextJson包。

三、实现API密钥认证 #

AppSync的API密钥认证只需要在请求头里添加x-api-key字段，值就是你的AppSync API密钥。这一步很简单，后面会在代码里体现。

四、编写查询逻辑 #

1. 定义查询的模型类 #

首先要把GraphQL的查询、变量和响应结果对应成C#类，这样序列化/反序列化的时候更方便。比如假设你要查询用户信息：

// 封装GraphQL查询内容和变量
public class GetUserQuery
{
    // 你的GraphQL查询语句
    public string Query => @"
        query GetUser($userId: ID!) {
            getUser(userId: $userId) {
                id
                name
                email
            }
        }";

    // 查询需要的变量
    public GetUserVariables Variables { get; set; }
}

// 查询变量类
public class GetUserVariables
{
    public string UserId { get; set; }
}

// 响应结果的根类
public class GetUserResponse
{
    public UserData Data { get; set; }
}

// 响应里的Data部分
public class UserData
{
    public User GetUser { get; set; }
}

// 最终要获取的用户实体
public class User
{
    public string Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
}

2. 在Web API控制器里实现调用 #

推荐用IHttpClientFactory来管理HttpClient（这是.NET官方推荐的最佳实践），然后注入到控制器里：

using GraphQL.Client;
using GraphQL.Client.Http;
using GraphQL.Client.Serializer.Newtonsoft;
using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("api/[controller]")]
public class UserController : ControllerBase
{
    private readonly IHttpClientFactory _httpClientFactory;
    // 建议把这些配置放到appsettings.json里，用IConfiguration读取，不要硬编码！
    private readonly string _appSyncEndpoint = "你的AppSync API端点URL";
    private readonly string _appSyncApiKey = "你的AppSync API密钥";

    public UserController(IHttpClientFactory httpClientFactory)
    {
        _httpClientFactory = httpClientFactory;
    }

    [HttpGet("{userId}")]
    public async Task<IActionResult> GetUser(string userId)
    {
        try
        {
            // 创建HttpClient并添加认证头
            var httpClient = _httpClientFactory.CreateClient();
            httpClient.DefaultRequestHeaders.Add("x-api-key", _appSyncApiKey);
            
            // 初始化GraphQL客户端
            var graphQlClient = new GraphQLHttpClient(
                new GraphQLHttpClientOptions { EndPoint = new Uri(_appSyncEndpoint) },
                new NewtonsoftJsonSerializer(),
                httpClient);

            // 构建查询请求
            var queryRequest = new GetUserQuery
            {
                Variables = new GetUserVariables { UserId = userId }
            };

            // 发送查询并获取响应
            var graphQlResponse = await graphQlClient.SendQueryAsync<GetUserResponse>(queryRequest);

            // 处理GraphQL返回的错误
            if (graphQlResponse.Errors != null && graphQlResponse.Errors.Any())
            {
                var errorMessages = string.Join(", ", graphQlResponse.Errors.Select(e => e.Message));
                return BadRequest($"GraphQL查询出错：{errorMessages}");
            }

            // 返回查询到的用户数据
            return Ok(graphQlResponse.Data.GetUser);
        }
        catch (Exception ex)
        {
            return StatusCode(StatusCodes.Status500InternalServerError, $"调用AppSync失败：{ex.Message}");
        }
    }
}

五、其他认证方式（简要说明） #

如果你的AppSync用的是IAM认证（更安全），步骤会复杂一点：

1. 安装AWS SDK相关包：AWSSDK.SecurityToken和AWSSDK.Extensions.NETCore.Setup
2. 在Program.cs里配置AWS服务：

builder.Services.AddDefaultAWSOptions(builder.Configuration.GetAWSOptions());
builder.Services.AddAWSService<IAmazonSecurityTokenService>();

3. 使用AWS4Signer为请求生成签名，并添加到请求头中。具体签名逻辑可以参考AWS官方文档，这里就不展开了。

六、一些注意事项 #

• 敏感配置（比如API密钥、端点）一定要放到配置文件（appsettings.json）里，不要硬编码在代码中
• 检查AppSync的API访问控制，确保你的.NET Web API服务器IP在允许访问的范围内
• 可以把AppSync的调用逻辑封装成一个独立的服务类，这样多个控制器都能复用，代码更整洁

内容的提问来源于stack exchange，提问作者Wasif Mustahid