.NET Core 2和SwashBuckle Swagger UI未显示

Question

我已经按照一些教程进行了工作,但由于某种原因,我无法显示UI,但是创建了Swagger Json.我看过的最后一个教程就在这里.

我的设置是这样的:

Nuget套餐: Swashbuckle.AspNetCore(1.0.0)

ConfigureServices 方法:

services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1",
                    new Info
                    {
                        Title = "MediatR Example",
                        Version = "v1",
                        Description = "Trying out the MediatR library to simplify Request and Response logic.",
                        TermsOfService = "WTFPL",
                        Contact = new Contact
                        {
                            Email = "",
                            Name = "",
                            Url = "https://github.com/CubicleJockey/MediatR-Playground"
                        }
                    }
                );

                var xmlDocFile = Path.Combine(PlatformServices.Default.Application.ApplicationBasePath, @"MediatR-Messages.Api.xml");
                options.IncludeXmlComments(xmlDocFile);
                options.DescribeAllEnumsAsStrings();
            });

Configure 方法:

 app.UseMvcWithDefaultRoute();

            // Enable middleware to serve generated Swagger as a JSON endpoint.
            app.UseSwagger();

            // Enable middleware to serve swagger-ui (HTML, JS, CSS etc.), specifying the Swagger JSON endpoint
            app.UseSwaggerUI(config =>
            {
                config.SwaggerEndpoint("/swagger/v1/swagger.json", "V1 Docs");
            });

launchSettings.json:

"IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "launchUrl": "swagger/",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },

运行和访问Swagger JSON url会生成相应的JSON:

   {
   "swagger":"2.0",
   "info":{
      "version":"v1",
      "title":"MediatR Example",
      "description":"Trying out the MediatR library to simplify Request and Response logic.",
      "termsOfService":"WTFPL",
      "contact":{
         "name":"André Davis",
         "url":"https://github.com/CubicleJockey/MediatR-Playground",
         "email":"davis.andre@gmail.com"
      }
   },
   "basePath":"/",
   "paths":{
      "/api/Addition":{
         "get":{
            "tags":[
               "Addition"
            ],
            "summary":"Get Methods that takes two numbers and gets the sum.",
            "operationId":"ApiAdditionGet",
            "consumes":[

            ],
            "produces":[
               "text/plain",
               "application/json",
               "text/json"
            ],
            "parameters":[
               {
                  "name":"left",
                  "in":"query",
                  "description":"Left hand side of the equation.",
                  "required":false,
                  "type":"integer",
                  "format":"int32"
               },
               {
                  "name":"right",
                  "in":"query",
                  "description":"Right hand side of the equation.",
                  "required":false,
                  "type":"integer",
                  "format":"int32"
               }
            ],
            "responses":{
               "200":{
                  "description":"Success",
                  "schema":{
                     "$ref":"#/definitions/Task[AdditionResponse]"
                  }
               }
            }
         }
      }
   },
   "definitions":{
      "Task[AdditionResponse]":{
         "type":"object",
         "properties":{
            "result":{
               "$ref":"#/definitions/AdditionResponse",
               "readOnly":true
            },
            "id":{
               "format":"int32",
               "type":"integer",
               "readOnly":true
            },
            "exception":{
               "type":"object",
               "readOnly":true
            },
            "status":{
               "enum":[
                  "Created",
                  "WaitingForActivation",
                  "WaitingToRun",
                  "Running",
                  "WaitingForChildrenToComplete",
                  "RanToCompletion",
                  "Canceled",
                  "Faulted"
               ],
               "type":"string",
               "readOnly":true
            },
            "isCanceled":{
               "type":"boolean",
               "readOnly":true
            },
            "isCompleted":{
               "type":"boolean",
               "readOnly":true
            },
            "isCompletedSuccessfully":{
               "type":"boolean",
               "readOnly":true
            },
            "creationOptions":{
               "enum":[
                  "None",
                  "PreferFairness",
                  "LongRunning",
                  "AttachedToParent",
                  "DenyChildAttach",
                  "HideScheduler",
                  "RunContinuationsAsynchronously"
               ],
               "type":"string",
               "readOnly":true
            },
            "asyncState":{
               "type":"object",
               "readOnly":true
            },
            "isFaulted":{
               "type":"boolean",
               "readOnly":true
            }
         }
      },
      "AdditionResponse":{
         "type":"object",
         "properties":{
            "answer":{
               "format":"int32",
               "type":"integer",
               "readOnly":true
            },
            "equation":{
               "type":"string",
               "readOnly":true
            }
         }
      }
   },
   "securityDefinitions":{

   }
}

当访问默认的Swagger UI网址时,我得到了404.尝试了一些变化.

1. 本地主机:64881 /招摇/
2. 本地主机:64881 /招摇/ UI
3. 本地主机:64881 /招摇/ index.html的
4. 本地主机:64881 /昂首阔步/ UI/index.html的

以上所有都返回404.这些都取决于版本.我错过了什么

我的完整源代码可以在GitHub上找到.这是这个问题的一个分支,所以代码符合我的要求.

Answer 1

下载并测试代码后,您必须将以下NuGet包添加到项目中:

Microsoft.AspNetCore.StaticFiles

您可以通过NuGet Manager或将以下行添加到.csproj中 <ItemGroup>

<PackageReference Include="Microsoft.AspNetCore.StaticFiles" Version="2.0.0" /> 

资料来源:https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/438

Answer 2

对我来说诀窍是什么:

1. 从部署文件夹中删除所有旧文件(我试过IIS,也适用于其他托管类型)
2. Microsoft.AspNetCore.*用Microsoft.AspNetCore.Allmeta包替换所有包 - 有关详细信息,请参阅此帖子.
3. [可选]只是副作用的情况下,重新安装Swashbuckle.AspNetCore包(不需要其他Swashbuckle.AspNetCore.*包)

4. 确保项目文件中包含这两个包(这足以使其工作):

   • PackageReference Include="Microsoft.AspNetCore.All" Version="2.0.0"
   • PackageReference Include="Swashbuckle.AspNetCore" Version="1.0.0"

5. 发布(或通过复制文件进行部署)到部署文件夹.现在它应该工作.

注意:如果您的API中有重复的模型名称,有时会失败(在这种情况下,它会在浏览器中显示一些不明确的错误);)

Answer 3

尝试删除.vs文件夹。升级到 ASP.NET Core 2.1 后为我修复了这个问题