unit-testing - 单元测试 Swagger 输出

Question

我在 ASP.NET MVC WebAPI 项目中使用 Swagger。该项目安装了 Swashbuckle 块包并生成 Swagger UI 和 Swagger/docs/v1。我一直遇到的一个问题是开发人员会通过不小心命名他们的 webAPI 操作来破坏 swagger 文件。我想添加一个单元测试，以防止我通过在部署后转到 Swagger UI 站点并看到 swagger UI 中显示的 HTTP 500 来发现 swagger/docs/v1 不可用。有人知道如何编写单元测试来验证 Swashbuckle 可以成功生成 swagger 文档吗？

Answer 1

找到了一个很好的方法来做我想做的事:

[Fact]
public async Task TestSwagger()
{
    var webHostBuilder =
          new WebHostBuilder()
                .UseEnvironment("Test") // You can set the environment you want (development, staging, production)
                .UseStartup<Startup>(); // Startup class of your web app project

    using (var server = new TestServer(webHostBuilder))
    using (var client = server.CreateClient())
    {
        string result = await client.GetStringAsync("/swagger/v1/swagger.json");
        JObject root = JObject.Parse(result);
    }
}

这使用以下 nuget 包:

Microsoft.AspNetCore.TestHost