AspNetCore+Swagger 生成Model 描述 前言: 本篇文章實現是基於上一篇文章,進下補充:多餘的就不多說了,只是為了實現Model的描述生成:有興趣的可以結合上一篇的進行實現:如有更好的辦法希望可以告知謝謝大家! 上一篇文章地址: https://www.cnblogs.com/s ...
AspNetCore+Swagger 生成Model 描述
前言:
本篇文章實現是基於上一篇文章,進下補充:多餘的就不多說了,只是為了實現Model的描述生成:有興趣的可以結合上一篇的進行實現:如有更好的辦法希望可以告知謝謝大家!
上一篇文章地址: https://www.cnblogs.com/szlblog/p/8068311.html
內容:
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中使用如下圖:
有不足之處 希望大家指出相互學習,
本文原創:轉載請註明出處 謝謝!