AspNetCore+Swagger 生成Model描述 AspNet Core Api Restful +Swagger 釋出IIS
AspNetCore+Swagger 生成Model 描述
前言:
本篇文章實現是基於上一篇文章,進下補充:多餘的就不多說了,只是為了實現Model的描述生成:有興趣的可以結合上一篇的進行實現:如有更好的辦法希望可以告知謝謝大家!
上一篇文章地址:AspNet Core Api Restful +Swagger 釋出IIS
內容:
1、:首先根據上一篇文章我們建立AspNetCoreApi的專案,OrderServices 如下如所示:
2、:建立Core的類庫專案並新增Users類如下圖所示:
開啟類庫的屬性:修改輸出項:如圖所示:
點選生成後會自動建立 BusinessBll.xml 文件:BusinessBll.xml 屬性修改如下圖所示:
Users類中內容如下:
using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; namespace BusinessBll { /// <summary> ///使用者類 /// </summary> public class Users { /// <summary> /// 使用者ID /// </summary> public int ID { get; set; } = 1; /// <summary> /// 使用者編號 /// </summary> public string Name { get; set; } /// <summary>/// 密碼 /// </summary> public string Pwd { get; set; } /// <summary> /// 使用者基本資訊 /// </summary> public UserInfo userInfo { get; set; } } /// <summary> /// 使用者的基本資訊 /// </summary> public class UserInfo { /// <summary> /// 地址資訊 /// </summary> public string Address { get; set; } /// <summary> /// 使用者編號 /// </summary> public int Phone { get; set; } } }
3、:在控制器ValuesController 的Post 方法用引用進行引用,如下圖所示:
4、:在Startup類中進行引用:
專案生成後:會有兩個XML文件:所以要使用兩個XML文件,如下圖所示
第一個是Web 專案生成的SwaggerDesc.xml文件內容如下:
第二個文件是類庫專案生成的 BusinessBll.xml 文件
5、:執行專案:結果如下圖所示:
6、:實際專案中是這樣使用的:
把讀取的XML路徑放置Json 檔案中。在Startup 中進行引用:如下圖所示:
有關路徑小注意的有兩點:
1)、:在本地執行是代表的是專案檔案所在盤的根路徑,
2)、:當我們執行在IIS的時候,此路徑代表的是,Web專案的根路徑。
在Startup中使用如下圖:
出處:https://www.cnblogs.com/szlblog/p/9440243.html
AspNetCore+Swagger 生成Model 描述
前言:
本篇文章實現是基於上一篇文章,進下補充:多餘的就不多說了,只是為了實現Model的描述生成:有興趣的可以結合上一篇的進行實現:如有更好的辦法希望可以告知謝謝大家!
上一篇文章地址:AspNet Core Api Restful +Swagger 釋出IIS
內容:
1、:首先根據上一篇文章我們建立AspNetCoreApi的專案,OrderServices 如下如所示:
2、:建立Core的類庫專案並新增Users類如下圖所示:
開啟類庫的屬性:修改輸出項:如圖所示:
點選生成後會自動建立 BusinessBll.xml 文件:BusinessBll.xml 屬性修改如下圖所示:
Users類中內容如下:
using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; namespace BusinessBll { /// <summary> /// 使用者類 /// </summary> public class Users { /// <summary> /// 使用者ID /// </summary> public int ID { get; set; } = 1; /// <summary> /// 使用者編號 /// </summary> public string Name { get; set; } /// <summary> /// 密碼 /// </summary> public string Pwd { get; set; } /// <summary> /// 使用者基本資訊 /// </summary> public UserInfo userInfo { get; set; } } /// <summary> /// 使用者的基本資訊 /// </summary> public class UserInfo { /// <summary> /// 地址資訊 /// </summary> public string Address { get; set; } /// <summary> /// 使用者編號 /// </summary> public int Phone { get; set; } } }
3、:在控制器ValuesController 的Post 方法用引用進行引用,如下圖所示:
4、:在Startup類中進行引用:
專案生成後:會有兩個XML文件:所以要使用兩個XML文件,如下圖所示
第一個是Web 專案生成的SwaggerDesc.xml文件內容如下:
第二個文件是類庫專案生成的 BusinessBll.xml 文件
5、:執行專案:結果如下圖所示:
6、:實際專案中是這樣使用的:
把讀取的XML路徑放置Json 檔案中。在Startup 中進行引用:如下圖所示:
有關路徑小注意的有兩點:
1)、:在本地執行是代表的是專案檔案所在盤的根路徑,
2)、:當我們執行在IIS的時候,此路徑代表的是,Web專案的根路徑。
在Startup中使用如下圖: