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中使用如下图:
有不足之处 希望大家指出相互学习,
本文原创:转载请注明出处 谢谢!
本文参考链接:https://www.cnblogs.com/szlblog/p/9440243.html