AspNetCore+Swagger 生成Model描述

 

AspNetCore+Swagger 生成Model 描述

 前言：

本篇文章實現是基於上一篇文章，進下補充：多餘的就很少說了，只是爲了實現Model的描述生成：有興趣的能夠結合上一篇的進行實現：若有更好的辦法但願能夠告知謝謝你們！

上一篇文章地址：AspNet Core Api Restful +Swagger 發佈IIS

 

 內容：

一、：首先根據上一篇文章咱們建立AspNetCoreApi的項目，OrderServices 以下如所示：

二、：建立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; } 
    }
}

 

 三、：在控制器ValuesController 的Post 方法用引用進行引用，以下圖所示：

 

 

四、：在Startup類中進行引用：

 

項目生成後：會有兩個XML文檔：因此要使用兩個XML文檔，以下圖所示

　　第一個是Web 項目生成的SwaggerDesc.xml文檔內容以下：

　　第二個文檔是類庫項目生成的 BusinessBll.xml 文檔

 

五、：運行項目：結果以下圖所示：

 

六、：實際項目中是這樣使用的：

把讀取的XML路徑放置Json 文件中。在Startup 中進行引用：以下圖所示：

 

 有關路徑小注意的有兩點：

　　1）、：在本地運行是表明的是項目文件所在盤的根路徑，

　　2）、：當咱們運行在IIS的時候，此路徑表明的是，Web項目的根路徑。

 在Startup中使用以下圖：

  

 

 

出處：https://www.cnblogs.com/szlblog/p/9440243.html