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

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

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

Quand j'ai commencé l'application de cette méthode, le message suivant a montré jusqu':

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

Erreurs

Chercher l'erreur Interne au Serveur Erreur /swagger/v1/swagger.json

Dès que je l'ai définie explicitement par exemple [HttpGet] l'erreur disparaît. Le problème avec ceci est que, j'ai besoin de cette méthode à feu pour tous les possibles HTTP opérations.
Bien sûr, je pourrais spécifier toutes les opérations de manière explicite, mais j'ai le sentiment Swagger doit être capable de gérer cela correctement.

Pourquoi ne Swagger se comporter de cette façon?

Est-il de la configuration que je peux utiliser?

  • "J'ai besoin de cette méthode à feu pour tous les possibles HTTP opérations" pourquoi avez-vous besoin d'un soutien à toutes les méthodes, plutôt que d'en OBTENIR?
  • Pouvez-vous partager votre Swashbuckle de configuration?
  • dans ce cas, le Error point de terminaison est utilisé en tant que gestionnaire d'exception. Selon l'opération de HTTP de la requête, la fonction de l'opération sur le Error extrémité est appelée.
  • la config est assez simple: services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Title = "My Service", Version = "v1" }); }); app.UseSwagger(c => { c.PreSerializeFilters.Add((swagger, httpReq) => swagger.Host = httpReq.Host.Value); }); app.UseSwaggerUI(c => { c.RoutePrefix = "swagger"; // serve the UI at root c.SwaggerEndpoint("/swagger/v1/swagger.json", "V1 Docs"); });
  • J'ai réussi à reproduire votre problème, ressemble à un Bug dans le Swashbuckle.AspNetCore, le ResolveConflictingActions devrait fonctionner
  • le code que vous avez fourni dans votre commentaire ci-dessus a fonctionné pour moi. Je suis l'aide de Swashbuckle.AspNetCore(3.0.0) et AspNetCore.Tous(2.0.9).

InformationsquelleAutor Ash | 2018-05-07
  1. 7

    L'option ResolveConflictingActions devrait travailler sur ce cas...

    Voici l'erreur:

    System.NotSupportedException: Ambiguous HTTP method for action

    Qui est à venir à partir de:
    https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/src/Swashbuckle.AspNetCore.SwaggerGen/Generator/SwaggerGenerator.cs#L90

    Je pense que c'est un bug, si vous êtes vraiment intéressé, vous devez le signaler au projet

    InformationsquelleAutor Helder Sepulveda
  2. 17

    Ajouter Httpxxx([HttpGet], [HttpPost], ...) attribut pour chaque méthode d'Action, ou [ApiExplorerSettings(IgnoreApi = true)]

    InformationsquelleAutor LiKui
  3. 5

    Je ne sais pas si cela a été résolu ou non, mais d'une façon, vous pouvez aller à ce sujet est par la décoration de la méthode:

    [ApiExplorerSettings(IgnoreApi = true)]

    Cela permettra d'assurer que la méthode en question est ignorée par Swagger.

    InformationsquelleAutor Moshood Aminu
  4. 4

    Un autre problème possible est que le point de terminaison doit être complet à partir de la racine du domaine.

    J'ai eu:

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

    J'ai eu à utiliser:

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

});
    InformationsquelleAutor Erick
  5. 3

    Dans ASP.NET de Base, si il y a un contrôleur de point de terminaison comme:

    [Route("images")]
[HttpGet("{id}")]

    Cela peut aussi échouer avec fetch a échoué. La solution est d'avoir quelque chose comme

    [HttpGet("images/{id}")]

    Même chose pour HttpPost.

    InformationsquelleAutor dansc
  6. 3

    Swagger jette aussi de la même exception s'il existe des méthodes publiques qui ne sont pas des actions dans un contrôleur. La solution est de faire tous protected ou private ou comme mentionné ajouter l'attribut [ApiExplorerSettings(IgnoreApi = true)].

    • J'ai eu une classe de base pour les contrôleurs avec un public en fonction d'assistance et de votre suggestion a résolu le problème en le rendant protected.
    InformationsquelleAutor Elphas
  7. 0

    J'ai été faire un TypeLoadException sur une classe que j'ai été la suppression qui a été utilisé. La solution dans mon cas, a été de supprimer les bin/obj/Debug du contenu du dossier. Nettoyer la solution + régénérer la solution ne résout pas pour moi.

    InformationsquelleAutor daniel.caspers
  8. 0

    J'avais aussi cette erreur car j'ai créé un contrôleur qui dosent ont [Route("api/[controller]")]. Après avoir, l'erreur a disparu.

    InformationsquelleAutor t-prisar
  9. 0

    Mon erreur raison était la même url, nom,

     [HttpGet("get/LeaveCommand/{id}")]

    Je utiliser la même url, et swagger ne peut pas les obtenir

     [HttpGet("get/LeaveCommand/{id}")]
    InformationsquelleAutor Ergin Çelik