温馨提示×

C# webapi swagger文档自动生成

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

要在C# WebAPI项目中使用Swagger文档自动生成功能,可以按照以下步骤操作:

  1. 安装Swagger NuGet包:打开Visual Studio,右键点击项目,选择“管理NuGet程序包”,搜索并安装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中间件:
app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
  1. 启动项目并访问Swagger文档:启动项目后,浏览器访问https://localhost:{port}/swagger即可查看自动生成的Swagger文档。

通过以上步骤,您就可以在C# WebAPI项目中使用Swagger文档自动生成功能了。

0