有没有方法为最新版本的API创建Swagger Doc？

Question

我使用名为“ Swagger”的dotnet工具来创建一个Swagger JSON文件，其中包含特定版本的API规格。 命令像： Swagger Tofile -serializeasv2-输出REST-API.JSON C：\ service.dll V1，

您可以看到，我必须将Swagger Doc doc name v1 v1传播到导出文件。该名称是API的版本。 有没有办法导出最新版本？

我试图创建一个带有名称“最新”的Swagger Doc，其中包含最新版本的API，但我不能。有人知道如何创建显示最新版本API的Swagger Doc吗？

Answer 1

V1是代码示例给出的默认名称，来自 swashbuckle项目：

services.AddMvc();

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

它没有特定的含义作为版本编号，而这正是代码作者选择称之为的。 “最新版本”是代码当前指定的任何内容。调用C.SwaggerDoc多次使用不同的名称揭示不同的摇摇欲坠文档，您可以选择使其名称表示一个版本 - 这取决于该项目的swashbuckle配置。

Answer 2

谢谢每个人的帮助。我找到了解决方案。

主要目标是避免在出现新版本API时更改控制台命令。我说的是最后一部分v1。如果出现V2 DOC，我必须将其传递给命令。

现在，我可以将最新值传递给命令，并获取包含最新版本API的REST-API.JSON。

swagger tofile --serializeasv2 --output rest-api.json C:\Service.dll latest

我所做的是：

在我的项目中，我实施了一个实现iswaggerProvider的服务装饰仪，

public class SwaggerGeneratorDecorator: ISwaggerProvider
{
    private readonly ISwaggerProvider _decorated;
    private readonly IApiDescriptionGroupCollectionProvider _provider;

    public SwaggerGeneratorDecorator(ISwaggerProvider decorated, IApiDescriptionGroupCollectionProvider provider)
    {
        _decorated = decorated;
        _provider = provider;
    }
        
    public OpenApiDocument GetSwagger(string documentName, string host = null, string basePath = null)
    {
        if (documentName == "latest")
        {
            var group = _provider.ApiDescriptionGroups.Items.MaxBy(group => group.GroupName);
            documentName = group?.GroupName ?? documentName;
        }

        return _decorated.GetSwagger(documentName, host, basePath);
    }
}

然后在服务集合中注册。

services.Decorate<ISwaggerProvider, SwaggerGeneratorDecorator>();

现在，当我使用“最新”参数运行命令时，我将使用最新的API版本获得生成的文件。