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