在ASP.NET Core 7中,使用Swagger UI和Swashbuckle来生成API文档和UI界面是非常常见的做法。下面是一个解决版本问题与路由相关的示例代码:
dotnet add package Microsoft.AspNetCore.Mvc.NewtonsoftJson
dotnet add package Swashbuckle.AspNetCore
Startup.cs
文件中的ConfigureServices
方法中,配置Swagger生成器和UI:using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "API", Version = "v1" });
// 添加注释生成器
c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "YourProjectName.xml"));
// 解决版本问题
c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());
});
}
Startup.cs
文件中的Configure
方法中,启用Swagger UI:public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// ...
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "API v1");
});
// ...
}
[ApiController]
[ApiVersion("1.0")]
[Route("api/v{version:apiVersion}/[controller]")]
public class YourController : ControllerBase
{
// ...
}
[HttpGet]
public IActionResult Get()
{
// ...
}
https://localhost:{port}/swagger/index.html
即可查看生成的Swagger UI界面,其中{port}
是你应用程序运行的端口号。这样,你就完成了ASP.NET Core 7 Web API Swagger UI / Swashbuckle 版本问题与路由相关的解决方法。你可以根据自己的需求添加更多的API版本和路由设置。