要在ASP.NET Core 2.1中使用Swagger(Swashbuckle)URL模板可选参数,可以按照以下步骤进行操作:
首先,确保你已经安装了Swashbuckle.AspNetCore NuGet包。可以通过NuGet包管理器控制台或在项目文件中手动添加依赖项。
在Startup.cs文件的ConfigureServices方法中,添加Swagger服务配置:
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "API", Version = "v1" });
});
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "API V1");
});
[Route("api/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
[HttpGet("{id}/{optionalParam?}")]
public ActionResult Get(int id, string optionalParam = null)
{
// Your logic here
return "value";
}
}
在上述示例中,id是必需的参数,而optionalParam是可选的参数。Swagger会自动将这些参数显示在API文档中,并允许用户在Swagger UI中输入这些参数。
这样,你就完成了在ASP.NET Core 2.1中使用Swagger(Swashbuckle)URL模板可选参数的配置。