温馨提示×

C# webapi swagger如何集成

c#
小樊
90
2024-07-30 15:43:12
栏目: 编程语言

要在C# WebAPI项目中集成Swagger,可以按照以下步骤进行操作:

  1. 安装Swashbuckle NuGet包:在Visual Studio中打开项目,右键单击解决方案中的“项目”文件夹,选择“管理NuGet程序包”。在NuGet程序包管理器中搜索“Swashbuckle”并安装最新版本的Swashbuckle.AspNetCore包。

  2. 配置Swagger中间件:在Startup.cs文件中的ConfigureServices方法中添加以下代码以启用Swagger中间件:

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});
  1. 使用Swagger中间件:在Startup.cs文件中的Configure方法中添加以下代码以启用Swagger UI:
app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
  1. 配置Swagger文档:在Controller类中使用Swagger特性来配置API文档,例如:
[Route("api/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
    [HttpGet]
    [ProducesResponseType(typeof(IEnumerable<string>), 200)]
    public ActionResult<IEnumerable<string>> Get()
    {
        return new string[] { "value1", "value2" };
    }
}
  1. 启动应用程序并访问Swagger UI:启动应用程序后,访问“/swagger”路径即可查看自动生成的API文档。

通过以上步骤,您可以在C# WebAPI项目中成功集成Swagger,并生成API文档以便于查看和测试。

0