如何编写通用RestSharp方法构建C#接口测试框架（SpecFlow+Xunit）

一、全局RestClient配置与复用 #

创建单例模式的全局配置类，统一管理RestClient实例，避免重复初始化：

public static class RestClientManager
{
    private static RestClient _client;

    public static RestClient GetClient()
    {
        if (_client == null)
        {
            // 统一配置基础URL、超时、全局请求头
            var options = new RestClientOptions("https://your-base-api-domain.com")
            {
                Timeout = 10000 // 10秒超时
            };
            _client = new RestClient(options);
            
            // 添加全局通用请求头，比如认证信息
            _client.AddDefaultHeader("Authorization", "Bearer your-static-token");
        }
        return _client;
    }
}

二、通用请求发送步骤（第一步） #

1. 动态构建请求逻辑 #

通过SpecFlow的参数绑定，根据Feature文件中的<ServiceName>和<Method>动态生成请求，并将响应存入ScenarioContext实现跨步骤共享：

[Binding]
public class CommonRequestSteps
{
    private readonly ScenarioContext _scenarioContext;
    private readonly RestClient _client;

    // 注入ScenarioContext，用于跨步骤传递响应数据
    public CommonRequestSteps(ScenarioContext scenarioContext)
    {
        _scenarioContext = scenarioContext;
        _client = RestClientManager.GetClient();
    }

    [When(@"I make a (.*)(.*) request")]
    public void WhenIMakeARequest(string serviceName, string method)
    {
        // 根据服务名拼接接口路径，比如UserService对应/api/users
        var requestPath = $"/api/{serviceName.ToLower()}";
        var request = new RestRequest(requestPath);

        // 根据请求方法动态执行请求
        RestResponse response = method.ToLower() switch
        {
            "get" => _client.ExecuteGet(request),
            "post" => _client.ExecutePost(request),
            "put" => _client.ExecutePut(request),
            "delete" => _client.ExecuteDelete(request),
            _ => throw new ArgumentException($"不支持的请求方法：{method}")
        };

        // 将响应存入ScenarioContext，供后续验证步骤调用
        _scenarioContext["ApiResponse"] = response;
        Debug.WriteLine($"响应状态码：{response.StatusCode}");
        Debug.WriteLine($"响应内容：{response.Content}");
    }
}

三、通用响应验证步骤（第二步） #

在公共步骤类中，从ScenarioContext取出响应，执行通用状态码验证：

[Binding]
public class CommonResponseSteps
{
    private readonly ScenarioContext _scenarioContext;

    public CommonResponseSteps(ScenarioContext scenarioContext)
    {
        _scenarioContext = scenarioContext;
    }

    [Then(@"I should get a success 200")]
    public void ThenIShouldGetASuccess200()
    {
        // 从上下文获取之前存储的响应
        if (_scenarioContext.TryGetValue("ApiResponse", out RestResponse response))
        {
            // 用Xunit断言验证状态码
            Assert.Equal(HttpStatusCode.OK, response.StatusCode);
        }
        else
        {
            throw new InvalidOperationException("未找到API响应，请先执行请求步骤");
        }
    }
}

四、核心优化点说明 #

• ScenarioContext共享机制：SpecFlow的ScenarioContext为每个测试场景独立存储数据，既保证不同场景的响应不互相干扰，又能让所有Feature的步骤通过注入访问上下文数据。
• 泛型响应扩展：如果需要强类型响应验证，可以修改请求执行逻辑为泛型方法：

  // 泛型请求执行示例
  public RestResponse<T> ExecuteGenericRequest<T>(RestRequest request, string method)
  {
      return method.ToLower() switch
      {
          "get" => _client.ExecuteGet<T>(request),
          "post" => _client.ExecutePost<T>(request),
          // 其他请求方法同理
      };
  }
  

  之后将泛型响应存入ScenarioContext：_scenarioContext["TypedApiResponse"] = typedResponse;
• 全局配置可扩展性：可在RestClientManager中添加代理、证书、日志拦截器等配置，统一管理所有请求的行为。

内容的提问来源于stack exchange，提问作者amazo Tv