簡體   English   中英

如果實體框架數據模型經常被覆蓋,如何使用Microsoft.AspNet.WebApi.HelpPage記錄它們?

[英]How can I use Microsoft.AspNet.WebApi.HelpPage to document Entity Framework data models if they are constantly over-written?

我的任務是使用代碼注釋和Microsoft.AspNet.WebApi.HelpPage包來記錄我們的API。

問題是我們使用實體框架,並且我們用於數據模型的類是自動生成的,並且在下次更新模型時將被覆蓋。 發生這種情況時,我的代碼注釋(以及我的文檔)將丟失。

Microsoft.AspNet.WebApi.HelpPage與實體框架一起使用的最佳方法是什么?

使用NuGet安裝Microsoft.AspNet.WebApi.HelpPage程序包

  1. 安裝這個nuget Nuget
  2. using System.Web.Routing;添加using System.Web.Routing; 到Global.asax
  3. 添加AreaRegistration.RegisterAllAreas(); 到Global.asax中的Application_Start()
  4. 建立專案
  5. 右鍵單擊項目名稱並選擇屬性
  6. 在構建選擇中檢查Xml文檔文件
  7. 設置為App_Data/YOUR-PROJECT-NAME.xml
  8. 保存項目
  9. 轉到Areas> HelpPage> App_Start> HelpPageConfig注釋行37,以使用XML文檔文件中的文檔。

     config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/YOUR-PROJECT-NAME.xml"))); 
  10. 結束

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM