溫馨提示×

C# webapi swagger如何集成

c#
小樊
132
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
亚洲午夜精品一区二区_中文无码日韩欧免_久久香蕉精品视频_欧美主播一区二区三区美女