Swagger .Net 核心

Question

我正在尝试为我的 .Netcore 应用程序 (1.1) 配置 swagger，但无法生成文档。

这是我的配置

public void ConfigureServices(IServiceCollection services) {

    services.AddMvcCore().AddVersionedApiExplorer(o => o.GroupNameFormat = "1.0");
    services.AddMvc();
    services.AddApiVersioning(opt =>
            {

                opt.ApiVersionReader = new HeaderApiVersionReader("api-version");
                opt.DefaultApiVersion = new ApiVersion(1, 0);
                opt.ReportApiVersions = true;
                opt.AssumeDefaultVersionWhenUnspecified = true;
            });
    services.AddSwaggerGen(
                options =>
                {
                    options.SwaggerDoc("1.0",new Info {Contact = new Contact() {Name="Admin" } });
                    // add a custom operation filter which sets default values
                    options.OperationFilter<SwaggerDefaultValues>();
                });
}

在配置方法中

app.UseMvc(routes =>
            {
                routes.MapRoute(
                    name: "default",
                    template: "{controller=User}/{action=Get}/{requestString?}");
            });

            app.UseSwagger(o=>
            {
                o.RouteTemplate = "docs/{documentName}/swagger.json";

            });
            app.UseSwaggerUI(
                options =>
                {
                    options.SwaggerEndpoint("/docs/1.0/swagger.json", "1.0");
                });

当我运行申请时， http://localhost:5000/docs/1.0/swagger.json

我正在获取以下方法，我的 API 中的 None 被发现了。

{"swagger":"2.0","info":{"contact":{"name":"Admin"}},"basePath":"/","paths":{},"definitions":{},"securityDefinitions":{}}

Answer 1

好的，我已经复现了你的问题，发现原因是GroupNameFormat选项中的值。

如果很快，您应该指定 version format 而不是常量版本字符串。由于您希望 url 中的版本与 1.0 相同，您可以使用：

services.AddMvcCore().AddVersionedApiExplorer( o => o.GroupNameFormat = "VVVV" );

来自文档中的 Version Format 部分：

Format Specifier: VVVV

Description: Major, minor version, and status

Examples: 1-RC -> 1.0-RC, 1.1 -> 1.1, 1 -> 1.0

Answer 2

关于 AddMvcCore() 与 AddMvc()：

来自 https://github.com/domaindrivendev/Swashbuckle.AspNetCore

的 swagger 文档

Swashbuckle relies heavily on ApiExplorer, the API metadata layer that ships with ASP.NET Core. If you're using the AddMvc helper to bootstrap the MVC stack, then ApiExplorer will be automatically registered and SB will work without issue. However, if you're using AddMvcCore for a more paired-down MVC stack, you'll need to explicitly add the Api Explorer service:

services.AddMvcCore().AddApiExplorer();

如果您还想要 AddVersionedApiExplorer()，请将其链接在 AddApiExplorer()

之后

Swagger .Net 核心

Swagger .Net Core

swagger

swashbuckle

asp.net-core