在C#中使用Swagger進行API文檔管理,你需要遵循以下步驟:
安裝Swashbuckle.AspNetCore庫:
首先,你需要在你的ASP.NET Core項目中安裝Swashbuckle.AspNetCore庫。這可以通過NuGet包管理器或者在項目文件夾中的.csproj文件里添加以下代碼來實現:
<ItemGroup>
<PackageReference Include="Swashbuckle.AspNetCore" Version="5.6.3" />
</ItemGroup>
然后運行dotnet restore
命令來安裝該庫。
在Startup.cs中配置Swagger:
打開項目中的Startup.cs文件,然后在ConfigureServices方法中添加以下代碼來配置Swagger:
public void ConfigureServices(IServiceCollection services)
{
// ...
services.AddSwaggerGen(options =>
{
options.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});
// ...
}
接下來,在Configure方法中添加以下代碼來啟用Swagger中間件:
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// ...
app.UseSwagger();
app.UseSwaggerUI(options =>
{
options.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
// ...
}
為你的API操作添加XML注釋:
為了讓Swagger顯示更詳細的文檔,你可以為你的API操作添加XML注釋。首先,在項目屬性中啟用XML文檔文件生成:
然后,在你的控制器類和方法上添加XML注釋:
///<summary>
/// My controller summary
/// </summary>
[ApiController]
[Route("[controller]")]
public class MyController : ControllerBase
{
///<summary>
/// Get a list of items
/// </summary>
///<returns>A list of items</returns>
[HttpGet]
public IEnumerable<string> Get()
{
return new string[] { "item1", "item2" };
}
}
在Startup.cs中配置Swagger使用XML注釋:
修改ConfigureServices方法中的Swagger配置,添加一個新的代碼行來指定XML注釋文件的路徑:
public void ConfigureServices(IServiceCollection services)
{
// ...
var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
options.IncludeXmlComments(xmlPath);
// ...
}
運行你的應用程序并訪問Swagger UI:
現在,你可以運行你的應用程序并在瀏覽器中訪問Swagger UI。默認情況下,Swagger UI的URL是https://localhost:5001/swagger/index.html
(端口號可能會有所不同)。你應該能看到你的API文檔和XML注釋。
通過以上步驟,你已經成功地在C#中使用Swagger進行API文檔管理。