ASP.NET Core Swagger 是一個用于自動生成 API 文檔的工具,它可以幫助開發人員更好地理解和使用 API。要處理請求,您需要遵循以下步驟:
dotnet add package Swashbuckle.AspNetCore
Startup.cs
文件中,您需要配置 Swagger 以便它能夠掃描您的控制器并生成文檔。在 ConfigureServices
方法中添加以下代碼:services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});
在 Configure
方法中添加以下代碼:
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
ValuesController
的控制器:using Microsoft.AspNetCore.Mvc;
[ApiController]
[Route("api/[controller]")]
public class ValuesController : ControllerBase
{
[HttpGet("{id}")]
public ActionResult<string> Get(int id)
{
return "Value: " + id;
}
[HttpPost]
public ActionResult<string> Post([FromBody] string value)
{
return "Value created: " + value;
}
}
訪問 Swagger 文檔:啟動應用程序后,您可以通過訪問 http://localhost:端口號/swagger
來查看生成的 Swagger 文檔。在這里,您可以看到您的控制器和 API 方法,以及它們的請求和響應示例。
測試 API:您可以通過 Swagger UI 中的“Try it out”按鈕測試您的 API 方法。這將發送一個實際請求到您的 API,并顯示響應結果。
通過以上步驟,您可以在 ASP.NET Core 項目中使用 Swagger 處理請求并自動生成 API 文檔。