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; } = ;
/// <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描述的更多相关文章

  1. AspNetCore+Swagger 生成Model 描述

    AspNetCore+Swagger 生成Model 描述 前言: 本篇文章实现是基于上一篇文章,进下补充:多余的就不多说了,只是为了实现Model的描述生成:有兴趣的可以结合上一篇的进行实现:如有更 ...

  2. asp.net core使用Swashbuckle.AspNetCore(swagger)生成接口文档

    asp.net core中使用Swashbuckle.AspNetCore(swagger)生成接口文档 Swashbuckle.AspNetCore:swagger的asp.net core实现 项 ...

  3. 浅析如何在Nancy中使用Swagger生成API文档

    前言 上一篇博客介绍了使用Nancy框架内部的方法来创建了一个简单到不能再简单的Document.但是还有许许多多的不足. 为了能稍微完善一下这个Document,这篇引用了当前流行的Swagger, ...

  4. asp.net core 使用 swagger 生成接口文档

    参考地址:http://www.cnblogs.com/daxnet/p/6181366.html http://www.jianshu.com/p/fa5a9b76f3ed 微软参考文档:https ...

  5. Swagger 生成 ASP.NET Web API

    使用 Swagger 生成 ASP.NET Web API 在线帮助测试文档 原文:ASP.NET Web API Help Pages using Swagger作者:Shayne Boyer翻译: ...

  6. Asp.net core WebApi 使用Swagger生成帮助页

    最近我们团队一直进行.net core的转型,web开发向着前后端分离的技术架构演进,我们后台主要是采用了asp.net core webapi来进行开发,开始每次调试以及与前端人员的沟通上都存在这效 ...

  7. ASP.NET WebAPI使用Swagger生成测试文档

    ASP.NET WebAPI使用Swagger生成测试文档 SwaggerUI是一个简单的Restful API测试和文档工具.简单.漂亮.易用(官方demo).通过读取JSON配置显示API .项目 ...

  8. ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了

    引言 在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发者 ...

  9. ASP.NET Core WebApi使用Swagger生成api

    引言 在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发者 ...

随机推荐

  1. 《软件调试 Windows概要》

    操作系统是计算机系统中的基本软件.它负责管理系统中的软硬件资源.通常都包括文件管理.内存管理.进程管理.打印管理.网络管理等基本功能.除此之外,支持调试也是操作系统设计的一项根本任务. 0x01  进 ...

  2. chmod +x 和 chmod u+x的区别

    常用: chmod a+x tomcat u 代表用户. g 代表用户组. o 代表其他. a 代表所有. 这意味着chmod u+x somefile 只授予这个文件的所属者执行的权限 而 chmo ...

  3. 设置checkBox不拦截焦点

    android:clickable="false"android:focusableInTouchMode="false"android:focusable=& ...

  4. ubuntu下用vagrant搭建集群环境

    1.安装virtualbox 终端输入:sudo apt-get install virtualbox(事实从来都不是一番风顺的.......) 正在读取软件包列表... 完成 正在分析软件包的依赖关 ...

  5. day 42 mysql 数据类型

    mysql 数据类型   数据类型 truncate t1 (删除表) # 无符号类型 alter table t1 modify id tinyint unsigned (表里有值,不能直接改) d ...

  6. WHID Injector:将HID攻击带入新境界

    HID Attack是最近几年流行的一类攻击方式.HID是Human Interface Device的缩写,意思是人机接口设备.它是对鼠标.键盘.游戏手柄这一类可以操控电脑设备的统称. 由于电脑对这 ...

  7. python day 16作业

    day18天作业及默写1,完成下列功能: 1.1创建一个人类Person,再类中创建3个静态变量(静态字段) animal = '高级动物' soup = '有灵魂' language = '语言' ...

  8. 神州数码RIP协议认证

    实验要求:掌握RIP协议的简单认证及MD5认证 拓扑如下 简单认证 R1 enable 进入特权模式 config  进入全局模式 hostname R1 修改名称 interface s0/1 进入 ...

  9. ecmall 基础类分析

    class ECBaseApp,继承自class BaseApp,是includes/ecapp.base.php文件. 该类是一个非常重要的类,他是各个APP的应用的基础继承类.处理相关的基础应用. ...

  10. Redis分布式锁实现

    redis分布式锁的一个简单直接的实现方法就是用 SET NX 命令设置一个设定了存活周期 TTL 的 Key 来获取锁,通过删除 Key 来释放锁,通过存活周期来避免死锁.不过这个方法存在单点故障风 ...