溫馨提示×

C# webapi swagger文檔自動生成

c#
小樊
132
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 踩