Swashbuckle/Swagger + ASP.Net Core : "Échec du chargement de la définition de l'API"

Question

Je développe une application ASP.NET Core 2 et j'ai inclus Swagger. Tout fonctionnait bien jusqu'à ce que j'introduise une méthode sans définir explicitement l'action HTTP :

public class ErrorController : Controller
{
    [Route("/error")]
    public IActionResult Index()
    {
        return StatusCode(500, new Error("Erreur interne."));
    }
}

Quand j'ai démarré l'application avec cette méthode, le message suivant est apparu :

Échec du chargement de la définition de l'API.

Erreurs
Erreur de récupération Erreur interne du serveur /swagger/v1/swagger.json

Dès que j'ai défini explicitement par exemple [HttpGet], l'erreur a disparu. Le problème est que j'ai besoin que cette méthode soit déclenchée pour toutes les opérations HTTP possibles. Bien sûr, je pourrais spécifier toutes les opérations explicitement, mais j'ai l'impression que Swagger devrait pouvoir gérer cela correctement.

Pourquoi Swagger se comporte-t-il de cette manière ?

Y a-t-il une configuration que je peux utiliser ?

services.AddSwaggerGen(c => 
{   
  c.SwaggerDoc("v1", new Info { Title = "Mon Service", Version = "v1" }); 
});  

app.UseSwagger(c => 
{   
  c.PreSerializeFilters.Add((swagger, httpReq) => swagger.Host = httpReq.Host.Value); 
});  

app.UseSwaggerUI(c => 
{   
  c.RoutePrefix = "swagger"; // servir l'interface utilisateur à la racine     
  c.SwaggerEndpoint("/swagger/v1/swagger.json", "Docs V1"); 
})

Answer 1

Assurez-vous que chaque méthode de contrôleur public possède :

• soit l'attribut Httpxxx ([HttpGet], [HttpPost], ...) pour les méthodes d'action,
• soit [ApiExplorerSettings(IgnoreApi = true)] pour les méthodes qui ne sont pas des actions de contrôleur

Answer 2

Tout simplement, vous pouvez regarder le journal dans la fenêtre de Sortie. L'erreur réelle peut être vue là-bas. Dans mon cas, j'ai oublié d'ajouter une action HTTP au-dessus d'une méthode

Answer 3

L'option ResolveConflictingActions devrait fonctionner dans ce cas...

Voici l'erreur actuelle :

System.NotSupportedException: Méthode HTTP ambiguë pour l'action

Cela provient de : https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/86cc761bc4f5dda796f80ad8dfd8bc205542a6f6/src/Swashbuckle.AspNetCore.SwaggerGen/Generator/SwaggerGenerator.cs#L90

Je pense qu'il s'agit d'un bogue, si vous êtes vraiment intéressé, vous devriez le signaler au projet

Answer 4

Je ne sais pas si cela a été résolu ou non mais une façon de procéder est de décorer la méthode avec :

[ApiExplorerSettings(IgnoreApi = true)]

Cela garantira que la méthode en question est ignorée par Swagger.

Answer 5

Un autre problème possible est que le point d'extrémité doit être complet à partir de la racine du domaine.

J'avais :

app.UseSwaggerUI(c =>
{
     c.SwaggerEndpoint("/swagger/v1/swagger.json", "Docs V1");
});

J'ai dû utiliser :

app.UseSwaggerUI(c=>
{
     c.SwaggerEndpoint("/monApi/swagger/v1/swagger.json", "Docs V1");

});