要在C# WebAPI项目中集成Swagger,可以按照以下步骤进行操作:
安装Swashbuckle NuGet包:在Visual Studio中打开项目,右键单击解决方案中的“项目”文件夹,选择“管理NuGet程序包”。在NuGet程序包管理器中搜索“Swashbuckle”并安装最新版本的Swashbuckle.AspNetCore包。
配置Swagger中间件:在Startup.cs文件中的ConfigureServices方法中添加以下代码以启用Swagger中间件:
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
[Route("api/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
[HttpGet]
[ProducesResponseType(typeof(IEnumerable<string>), 200)]
public ActionResult<IEnumerable<string>> Get()
{
return new string[] { "value1", "value2" };
}
}
通过以上步骤,您可以在C# WebAPI项目中成功集成Swagger,并生成API文档以便于查看和测试。