Início / coding / Perguntas / 79551461
Accepted
James
Asked: 2025-04-03 03:57:30 +0800 CST

Como incluir o caminho no elemento url do servidor da especificação OpenAPI gerada pelo aplicativo ASP.NET Core Minimal API?

  • 772

Tenho um aplicativo C# / ASP.NET Core Minimal API com Swagger gerando uma especificação OpenAPI. Para corresponder ao yml de publicação, preciso adicionar um servidor com caminho e remover os elementos de caminho de grupos individuais.

Eu Program.csconfiguro o gerador com este código:

.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo
    {
        Title = "My API",
        Version = "2.0",
    });

    c.AddServer(new OpenApiServer
    {
        Url = "https://api.myapi.org.uk/api/v2",
        Description = "Production"
    });

    c.AddServer(new OpenApiServer
    {
        Url = "https://localhost:{port}/api/v2",
        Description = "Local",
        Variables =
        {
            new ("port", new OpenApiServerVariable
            {
                Default = "7147",
            }),
        },
    });
})

Depois, mapeie um ponto final em um grupo como:

var builder = app.MapGroup("/needs");
builder .MapGet("/", async (CancellationToken cancellationToken) => { ... });

Quando tento testar isso com a Swagger UI, recebo uma resposta 404. Mas se eu mover o caminho do servidor para o grupo, funciona perfeitamente.

.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo
        {
            Title = "My API",
            Version = "2.0",
        });

        c.AddServer(new OpenApiServer
        {
            Url = "https://api.myapi.org.uk/",
            Description = "Production"
        });

        c.AddServer(new OpenApiServer
        {
            Url = "https://localhost:{port}/",
            Description = "Local",
            Variables =
            {
                new ("port", new OpenApiServerVariable
                {
                    Default = "7147",
                }),
            },
        });
    })

// ...

var builder = app.MapGroup("/api/v2/needs");
builder .MapGet("/", async (CancellationToken cancellationToken) => { ... });

Eu tentei muitas combinações, mas não consigo descobrir o que está errado. Isso acontece por acaso de ser parte da especificação que não foi implementada corretamente ou há uma maneira de fazer funcionar?

Em última análise, a definição gerada precisa se parecer com

openapi: 3.0.1
info:
  title: My API
  version: '2.0'
servers:
  - url: https://myapi.org.uk/api/v2
    description: Production
  - url: 'https://localhost:{port}'
    description: Local
    variables:
      port:
        default: '7147'

paths:
  /needs:
    get:
      ...
c#

1 respostas

  1. Best Answer

    Devemos usar app.UsePathBasepara consertar o problema. Aqui está meu código de teste.

    Microsoft.AspNetCore.OpenApipacote é necessário.

    using Microsoft.OpenApi.Models;
using Microsoft.AspNetCore.OpenApi;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
//builder.Services.AddSwaggerGen();
builder.Services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo
    {
        Title = "My API",
        Version = "2.0",
    });

    c.AddServer(new OpenApiServer
    {
        Url = "https://api.myapi.org.uk/api/v2",
        Description = "Production"
    });

    c.AddServer(new OpenApiServer
    {
        Url = "https://localhost:{port}/api/v2",
        Description = "Local",
        Variables =
        {
            ["port"] = new OpenApiServerVariable
            {
                Default = "7147",
            }
        }
    });
});


var app = builder.Build();

app.UsePathBase("/api/v2");
app.UseRouting();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API v1");
    });
}

app.UseHttpsRedirection();

app.UseAuthorization();

var needsGroup = app.MapGroup("/needs");
needsGroup.MapGet("/", () => "Hello from Needs API!")
    .WithOpenApi();

app.Run();

    insira a descrição da imagem aqui

    • 1

relate perguntas