温馨提示×

C# Swagger如何实现接口自动化测试

c#
小樊
83
2024-08-27 01:22:35
栏目: 编程语言

要在C#中使用Swagger进行接口自动化测试,你需要遵循以下步骤:

  1. 安装Swashbuckle.AspNetCore库:

    在你的ASP.NET Core项目中,通过NuGet包管理器或命令行安装Swashbuckle.AspNetCore库。在命令行中运行以下命令:

    dotnet add package Swashbuckle.AspNetCore
    
  2. 配置Swagger:

    Startup.cs文件中,配置Swagger服务和中间件。这将生成一个Swagger JSON文件,其中包含有关你的API的信息。

    public void ConfigureServices(IServiceCollection services)
    {
        // ...
        services.AddSwaggerGen(options =>
        {
            options.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
        });
    }
    
    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        // ...
        app.UseSwagger();
        app.UseSwaggerUI(options =>
        {
            options.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
        });
    }
    
  3. 创建测试项目:

    在解决方案中创建一个新的C#测试项目(例如,使用MSTest或NUnit)。

  4. 安装RestSharp库:

    在测试项目中,通过NuGet包管理器或命令行安装RestSharp库。在命令行中运行以下命令:

    dotnet add package RestSharp
    
  5. 编写自动化测试:

    在测试项目中,编写自动化测试,使用RestSharp库调用API并验证结果。例如,你可以创建一个名为ApiTests.cs的文件,并编写以下内容:

    using Microsoft.VisualStudio.TestTools.UnitTesting;
    using RestSharp;
    using System.Linq;
    
    [TestClass]
    public class ApiTests
    {
        private readonly string _baseUrl = "https://localhost:5001";
    
        [TestMethod]
        public void GetUsers_ReturnsOk()
        {
            var client = new RestClient($"{_baseUrl}/api/users");
            var request = new RestRequest(Method.GET);
            var response = client.Execute(request);
    
            Assert.AreEqual(System.Net.HttpStatusCode.OK, response.StatusCode);
        }
    
        [TestMethod]
        public void GetUserById_ReturnsOk()
        {
            var client = new RestClient($"{_baseUrl}/api/users/1");
            var request = new RestRequest(Method.GET);
            var response = client.Execute(request);
    
            Assert.AreEqual(System.Net.HttpStatusCode.OK, response.StatusCode);
        }
    }
    
  6. 运行自动化测试:

    在测试项目中,运行自动化测试。这将调用你的API并验证结果是否符合预期。

注意:这里的示例仅用于演示目的。你需要根据你的实际API端点和预期结果修改测试代码。

0