Asp.net Web API中AddSwaggerGen()方法的具体作用是什么？

在ASP.NET Web API中，AddSwaggerGen() 是配置Swagger生成器的核心方法，主要作用如下：

• 自动生成API文档：它会扫描项目中的控制器、Action、模型类等，自动生成符合OpenAPI规范的API文档，无需手动编写，大幅减少文档维护成本。
• 提取并展示API元数据：能自动抓取API的路由、请求参数、响应类型、状态码等关键元数据，让文档清晰呈现每个接口的细节。
• 支持直接接口测试：搭配Swagger UI使用时，生成的文档页面可直接在浏览器内调用接口，输入参数就能完成测试，不用依赖Postman等外部工具。
• 支持自定义扩展配置：可以通过链式调用添加自定义规则，比如给接口加注释、设置文档版本、配置安全验证（如JWT）等，示例代码如下：

  builder.Services.AddSwaggerGen(options =>
  {
      options.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
      // 加载项目XML注释文档
      var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
      var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
      options.IncludeXmlComments(xmlPath);
  });
  

简单来说，这个方法就是帮你把Web API的接口信息自动转换成标准化的可交互文档，让开发、测试和团队协作更高效。

内容的提问来源于stack exchange，提问作者Mohammad Mahdi Moghaddam