.NET Core 2.1上的Swashbuckle / Swagger自升级以来已停止工作

6 回答

• 2

  这通常表示Swashbuckle因某种原因不支持的控制器/操作 .

  预计您的项目中没有swagger.json文件 . Swashbuckle使用ASP.NET Core的ApiExplorer API动态创建和提供 . 这里可能发生的事情是Swashbuckle无法生成Swagger.json，因此UI无法显示 .

  正如HelderSepu所说，它知道你控制器的哪一半包含了麻烦的动作 . 您可以'binary search'删除控制器（然后执行操作），直到找出导致Swashbuckle无法生成Swagger.json的操作方法 . 一旦你知道这一点，你的代码中是否存在某些问题或应该在Swashbuckle repo中提交的问题应该是显而易见的 .

  例如，Swashbuckle似乎不支持开放泛型，因此具有响应类型属性（如 [ResponseType(typeof(IEnumerable<>))] ）可能会导致此类行为 . 这也可能是一个模糊的路线问题或者像Swashbuckle绊倒的事情 . 一旦你将失败的原因缩小到更具体的东西，就可以酌情修复或归档 .

  回复于 2024-05-04T21:51:24+08:00
• 2

  在我的情况下，我可以通过从结束点省略"."来重现您的错误 .
  

  如果我包含“ . ”，我不会收到错误 . 在路径的开头 . 如果它是相关的，这里有更多我的代码 .

  在ConfigureServices中我有

  services.AddSwaggerGen(c =>
      {
          c.OperationFilter<AuthorizationHeaderParameterOperationFilter>();
  
          c.SwaggerDoc("v1", new Info
          {
              Version = "v1",
              Title = "My API",
              Description = "ASP.NET Core Web API",
              TermsOfService = "None",
              Contact = new Contact
              {
                  Name = "my name",
                  Email = "me@myemail.com"
              }
          });
      });
  

  在配置中

  public void Configure(IApplicationBuilder app, IHostingEnvironment env)
  {
      app.UseAuthentication();
  
      if (env.IsDevelopment())
      {
          app.UseDeveloperExceptionPage();
          app.UseDatabaseErrorPage();
      }
      else
      {
          app.UseExceptionHandler("/Error");
          app.UseHsts();
      }
  
      app.UseHttpsRedirection();
      app.UseStaticFiles();
      app.UseCookiePolicy();
  
  
      app.UseRewriter(new RewriteOptions()
          .AddRedirectToHttpsPermanent());
  
      app.UseSwagger(c =>
      {
          c.RouteTemplate =
              "api-docs/{documentName}/swagger.json";
      });
      app.UseSwaggerUI(c =>
      {
          //Include virtual directory if site is configured so
          c.RoutePrefix = "api-docs";
          c.SwaggerEndpoint("./v1/swagger.json", "Api v1");
      });
  
      app.UseMvc(routes =>
      {
          routes.MapRoute(
              "default",
              "{controller=Home}/{action=Index}/{id?}");
      });
  

  还有

  public class AuthorizationHeaderParameterOperationFilter : IOperationFilter
      {
          public void Apply(Operation operation, OperationFilterContext context)
          {
              var filterPipeline = context.ApiDescription.ActionDescriptor.FilterDescriptors;
              var isAuthorized = filterPipeline.Select(filterInfo => filterInfo.Filter).Any(filter => filter is AuthorizeFilter);
              var allowAnonymous = filterPipeline.Select(filterInfo => filterInfo.Filter).Any(filter => filter is IAllowAnonymousFilter);
  
              if (isAuthorized && !allowAnonymous)
              {
                  if (operation.Parameters == null)
                      operation.Parameters = new List<IParameter>();
  
                  operation.Parameters.Add(new NonBodyParameter
                  {
                      Name = "Authorization",
                      In = "header",
                      Description = "access token",
                      Required = true,
                      Type = "string"
                  });
              }
          }
  

  我的依赖是

  Microsoft.AspNetCore.App (2.1.0)
  Swashbuckle.AspNetCore (2.5.0)
  Microsoft.NETCore.App (2.1.0)
  

  回复于 2024-05-04T21:51:24+08:00
• 6

  我能够通过显式添加http动词属性到我的asp.net core 2.x控制器方法来解决这个错误 . 对于Swashbuckle来说，使用http动词为方法名称加前缀的约定是不够的 .

  [HttpPost] public async Task<IActionResult> AddNewData([FromBody] MyType myType) { … }

  回复于 2024-05-04T21:51:24+08:00
• 2

  今天我发现我可以在浏览器中找到json url并获取一些错误信息

  myapiurl / API / VI / swagger.json

  回复于 2024-05-04T21:51:24+08:00
• 1

  就个人而言，我有点快，忘了将此行添加到Startup.cs中的方法ConfigureServices .

  services.AddSwaggerDocument();

  回复于 2024-05-04T21:51:24+08:00
• 0

  就我而言，我错过了'HttpAttribute'：

  public async Task<IEnumerable<ClientesListDto>> GetAll()
  {
       return await _service.GetAllAsync();
  }
  

  然后我把它放在心里喜欢它：

  [HttpGet]
  public async Task<IEnumerable<ClientesListDto>> GetAll()
  {
       return await _service.GetAllAsync();
  }
  

  回复于 2024-05-04T21:51:24+08:00