feat: configurar swagger con soporte para multiples versiones v1 y v2
This commit is contained in:
@@ -1,44 +1,52 @@
|
||||
// ApiVersioningDemo.api/Program.cs
|
||||
using ApiVersioningDemo.Api;
|
||||
using Asp.Versioning;
|
||||
|
||||
var builder = WebApplication.CreateBuilder(args);
|
||||
|
||||
// CONFIGURACIÓN DE VERSIONADO
|
||||
// 1. Configuración de Versionado (YA LO TENÍAS)
|
||||
builder.Services.AddApiVersioning(options =>
|
||||
{
|
||||
// Si el cliente no especifica versión, usaremos la 1.0 por defecto
|
||||
options.DefaultApiVersion = new ApiVersion(1, 0);
|
||||
options.AssumeDefaultVersionWhenUnspecified = true;
|
||||
|
||||
// Esto añade una cabecera HTTP en las respuestas diciendo qué versiones existen (ej: api-supported-versions: 1.0, 2.0)
|
||||
options.ReportApiVersions = true;
|
||||
})
|
||||
.AddMvc() // Integra el versionado con los Controladores
|
||||
.AddMvc()
|
||||
.AddApiExplorer(options =>
|
||||
{
|
||||
// Configura el formato para Swagger (ej: "v1", "v2")
|
||||
options.GroupNameFormat = "'v'VVV";
|
||||
// IMPORTANTE: El formato "'v'VVV" hace que la versión se llame "v1", "v2", etc.
|
||||
options.GroupNameFormat = "'v'VVV";
|
||||
options.SubstituteApiVersionInUrl = true;
|
||||
});
|
||||
|
||||
// 2. Configuración de Swagger
|
||||
builder.Services.AddEndpointsApiExplorer();
|
||||
builder.Services.AddSwaggerGen();
|
||||
|
||||
// Esta lógica crea un documento Swagger por cada versión descubierta automáticamente
|
||||
builder.Services.ConfigureOptions<ConfigureSwaggerOptions>();
|
||||
|
||||
// Add services to the container.
|
||||
builder.Services.AddControllers();
|
||||
// Learn more about configuring OpenAPI at https://aka.ms/aspnet/openapi
|
||||
builder.Services.AddOpenApi();
|
||||
|
||||
var app = builder.Build();
|
||||
|
||||
// Configure the HTTP request pipeline.
|
||||
// 3. Activar la Interfaz Gráfica
|
||||
if (app.Environment.IsDevelopment())
|
||||
{
|
||||
app.MapOpenApi();
|
||||
app.UseSwagger();
|
||||
app.UseSwaggerUI(options =>
|
||||
{
|
||||
// Genera un endpoint JSON por cada versión que exista en la API
|
||||
var descriptions = app.DescribeApiVersions();
|
||||
foreach (var description in descriptions)
|
||||
{
|
||||
var url = $"/swagger/{description.GroupName}/swagger.json";
|
||||
var name = description.GroupName.ToUpperInvariant();
|
||||
options.SwaggerEndpoint(url, name);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
app.UseHttpsRedirection();
|
||||
|
||||
app.UseAuthorization();
|
||||
|
||||
app.MapControllers();
|
||||
|
||||
app.Run();
|
||||
app.Run();
|
||||
Reference in New Issue
Block a user