2017-08-07 33 views
0

我有一個公用的類庫,它被封裝爲自己的塊金庫。所有模型都沒有獲得Xml的類庫對Swagger的評論

它nuspec看起來像下面的xml:

<?xml version="1.0"?> 
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd"> 
    <metadata> 
    <id>MyCompany.MyDTOPackage</id> 
    <version>1.0.0.0</version> 
    <authors>Nate Tregillus</authors> 
    <owners>nate</owners> 
    <projectUrl>https://github.com/myCompany/ClassLibrary</projectUrl> 
    <requireLicenseAcceptance>false</requireLicenseAcceptance> 
    <releaseNotes>Intital Release</releaseNotes> 
    <description>Common Data Transfer Objects for all apps</description> 
    <tags>dto models</tags> 
    </metadata> 
</package> 

當我從該文件編譯NuGet包,內容如下:

lib 
-- net45 
-- -- MyCompany.MyDTOPackage.dll 
-- -- MyCompany.MyDTOPackage.xml 

當我試圖用這個包,並在我的swagger文檔中使用包中的模型,它們在我本地調試時出現,但在我通過Kudu部署我的webapi項目時出現。看着Kudu正在構建的軟件包,它完全忽略了MyCompany.MyDTOPackage.xml文件。我不懂爲什麼。有什麼我可以做的這個工作?

回答

0

這不是一個金塊,招搖或swashbuckle問題,但事實上,它的工作原理本地它指向部署一個問題...

我會建議您聯繫捻團隊:
https://github.com/projectkudu/kudu#questions



替代的方法是,以包括XML文件作爲嵌入式資源並加載這種方式。
如果您正在使用Swashbuckle你將需要添加一個XML包括像:

IncludeXmlComments(() => new XPathDocument(
     thisAssembly.GetManifestResourceStream("FilePath.xml"))); 

如果您正在使用Swagger-Net它應該工作,檢查是否有IncludeAllXmlComments,它是默認啓用的。

enter image description here

+0

哦有趣!我看起來好像可能適合我!現在嘗試它。 –

+0

是的,它應該工作,我揚鞭-NET的開發人員,我有使XML註釋的重中之重,測試的所有可能出現的情況,不應該有任何問題 – HelderSepu

+0

我不知道你是如何在編譯您的意見項目的根...您的xml文檔設置在項目的構建設置中是什麼樣子的? –

相關問題