使用Swashbuckle生成yaml swagger

Question

我在使用windows' tutorial的Web API項目中獲取json文件時沒有問題。

由於某些要求，我希望能夠檢索yaml文件。但問題是我沒有找到能夠實現這一目標的機會。

有沒有人知道任何解決方法這個問題？

Answer 1

的選擇將是一個IDocumentFilter添加到您的項目，這裏有幾個樣本：

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()); 
       } 
      } 
     } 
    } 

但如果加上取決於你的項目對YamlSerializer或YamlDotNet的附加參考是可以接受的。