Générer yaml swagger en utilisant Swashbuckle

Question

Je n'ai eu aucun problème pour obtenir un fichier json dans mon projet API Web en utilisant windows' tutorial.

En raison de certaines exigences, je voudrais être en mesure de récupérer un fichier yaml. Mais le problème est qu'il n'y a pas de crochet que je pourrais trouver pour rendre cela possible.

Est-ce que quelqu'un sait solution de contournement pour ce problème?

Answer 1

Une option sera d'ajouter un IDocumentFilter à votre projet, voici quelques échantillons:

private class YamlDocumentFilter : IDocumentFilter 
    { 
     public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer) 
     { 
      string file = AppDomain.CurrentDomain.BaseDirectory + "swagger_yaml.txt"; 
      if (!File.Exists(file)) 
      { 
       var serializer = new YamlSerializer(); 
       serializer.SerializeToFile(file, swaggerDoc); 
      } 
     } 
    } 

...

private class YamlDocumentFilter : IDocumentFilter 
    { 
     public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer) 
     { 
      string file = AppDomain.CurrentDomain.BaseDirectory + "swagger.yaml"; 
      if (!File.Exists(file)) 
      { 
       var serializer = new YamlDotNet.Serialization.Serializer(); 
       using (var writer = new StringWriter()) 
       { 
        serializer.Serialize(writer, swaggerDoc); 
        var stream = new StreamWriter(file); 
        stream.WriteLine(writer.ToString()); 
       } 
      } 
     } 
    } 

mais cela dépend de votre projet si l'ajout une référence supplémentaire à YamlSerializer ou YamlDotNet est acceptable.