netcore webapi帮助文档设置】的更多相关文章

如何建 .netcore webapi 项目这个就不说了,这个都没有没必要看下去. 我这里是.netcore 2.0,虽然没测过1.0的,但想来差不多. 1.Nuget Packages安装,使用程序包管理器控制台,安装命令:Install-Package Swashbuckle.AspNetCore -Pre 或者搜索安装  Swashbuckle.AspNetCore.Swagger 2.生成项目xml文档,多项目的情况下 3.配置Startup.cs.为了直观,我把整个类贴这里了,具体功能…
1.1  创建HTML文件 本质上,HTML文件就是具有下列两个特征的简单文本文件: HTML文件的扩展名为.html或者.htm.文件扩展名是一个缩写,它可将文件正确地关联到需要访问它的程序或工具. HTML文件由标记(tag)组成.标记就是用于告诉计算机如何显示页面内容的命令或程序. 命名规范: 统一使用一种扩展名,以免使自己.浏览器或用户产生混淆. 一些Web服务器区分大小写,因此当命名或引用文件名时请注意,要保持文件名大小写统一. 使用只包含字母字母和数字的简单文件名.请不要使用除连字符…
1. 权限 有3个默认的权限用户: 1.System Owner so 管理员权限全部:Type Setup; Group Setup; Form Setup; Role Setup; Share Role Setup; Data Set setup; Lookup Setup; Batch Admin; Message Admin; Process Admin and Transform 内容权限:全部 2.System Administration sa 管理员权限:Document Def…
前言: 你先得知道HelpPageConfig文件,不知道说明你现在不需要这个,所以下文就不用看了,等知道了再看也不急.当然如果你很知道这个,下文也不用看了,因为你会了. 方法一: new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml")) 替换成 new XmlDocumentationProvider("PluginsFolder/*.xm…
生成自己的Webapi帮助文档(一) 最近Webapi接口的开发刚刚进入尾声,随之而来的是让用户知道接口的详细参数信息,看过淘宝的接口文档,但网上没找到他的实现方式 虽然新建Webapi时C#也会给你一个帮助文档的Area,但是总觉得有些太复杂了,实用性值得商榷,于是对他做了些阉割,就有了自己的一个版本. 今天只完成了一些基本框架,具体细节有待进一步实现. 总体思路如下: 1:扩展HttpConfiguration的属性来加入自己的帮助文档生成器, 2:在每个Controller中添加该Cont…
我们可以给一些重要文档或者临时文件设置过期时间和过期信息提示来提醒读者或管理者文档的时效性,并及时对文档进行调整.更新等.下面,分享通过C#程序代码来给PDF文档设置过期时间的方法. 引入dll程序集 [方法1]通过 NuGet 安装. 可以在Visual Studio中打开"解决方案资源管理器",鼠标右键点击"引用","管理NuGet包",然后搜索"Free Spire.PDF",点击"安装". 也可以将…
ASP.NET WebAPI使用Swagger生成测试文档 SwaggerUI是一个简单的Restful API测试和文档工具.简单.漂亮.易用(官方demo).通过读取JSON配置显示API .项目本身仅仅也只依赖一些html,css,js静态文件.你可以几乎放在任何Web容器上使用 捣鼓了好久最终效果如下 1.API控制器和action描述 2.测试接口 使用swagger 1.创建webapi项目解决方案 2.引用swagger nuget包 swashbuckle和swagger.NET…
Swagger也称为Open API,Swagger从API文档中手动完成工作,并提供一系列用于生成,可视化和维护API文档的解决方案.简单的说就是一款让你更好的书写API文档的框架. 我们为什么选择swagger,现在的网站开发结果越来越注重前后端的分离,比如以前的webFrom到现在的mvc模式都是为了这个前后端的分离.就算再如何的分离实现,也是不可避免的要进行数据交互的,那么接口的重要性就提现出来了.他成了前端和后端交互的重要途径,API文档也因此成了前端开发人员与后端开发人员的重要纽带.…
1.找到已经成功安装过的项目根目录的packages文件夹拷贝到新的项目的根目录 2.vs设置nuget程序包源 将源:地址改为新项目的packages文件夹 3.重新编译并修改代码 右键项目->属性->生成->输出 勾上xml文档文件(x)记录下xml文档的文件名(如website.xml) 并重新编译 找到app_start文件夹,打开swaggerconfig.cs搜索如下代码: c.IncludeXmlComments(GetXmlCommentsPath()) 将本行的注释取消…
最近Webapi接口的开发刚刚进入尾声,随之而来的是让用户知道接口的详细参数信息,看过淘宝的接口文档,但网上没找到他的实现方式 虽然新建Webapi时C#也会给你一个帮助文档的Area,但是总觉得有些太复杂了,实用性值得商榷,于是对他做了些阉割,就有了自己的一个版本. 今天只完成了一些基本框架,具体细节有待进一步实现. 总体思路如下: 1:扩展HttpConfiguration的属性来加入自己的帮助文档生成器, 2:在每个Controller中添加该Controller的帮助信息 3:查看HTM…
office本来不是很难,关键就是经验吧,直入主题. 文档结构图设置了四级,但是目录始终只显示三级,郁闷了好久,网上看的也不靠谱,方法如下: 引用-目录-插入目录 弹出插入目录设置后,修改级别为最大,可以看出最大为九级目录,可以满足需要了,注意选择为9,1-9的都可以显示, 9以上的就无法显示了,当然文档结构里面也没有9级以上的一般.…
在做webapi项目的时候 webapi为我们提供了help文档,开发者可以参考这个文档,但是这个文档缺少测试功能,如果加上一个测试的功能就更加方便了 于是就研究了下写了一段代码,代码比较简单,只要将这段代码贴在areas\helppage\views\help\api.cshtml中就可以了,如果多个api项目都依次加上,因为感觉比较实用就分享出来 如果你的接口不需要验证,请自行修改下代码,测试时可以复制文档中提供的参数格式进行修改 <div id="test"> <…
<html> <head> <title>第四课的标题及第五课的标题</title> <meta charset="utf-8"> </head> <body> HN标记 六个不同的 HTML 标题:所有浏览器都支持 <h1> - <h6> 标签.定义和用法 <h1> - <h6> 标签可定义标题.<h1> 定义最大的标题.<h6>…
nuget安装Swashbuckle包 修改SwaggerConfig文件 //c.IncludeXmlComments(GetXmlCommentsPath()); //设置接口描述xml路径地址 c.IncludeXmlComments(string.Format("{0}/bin/SwaggerDemo.XML", System.AppDomain.CurrentDomain.BaseDirectory)); 给接口添加注释,即可看到参数及方法描述了       http://w…
package poi_test; import java.io.FileOutputStream; import java.io.IOException; import org.apache.poi.hssf.usermodel.HSSFCell; import org.apache.poi.hssf.usermodel.HSSFCellStyle; import org.apache.poi.hssf.usermodel.HSSFFont; import org.apache.poi.hss…
格式标记 1.<br> 强制换行标记,让后面的文字.图片.表格等,显示在下一行.单标记 2.<p> 换段落标记,换段落是由于多个空格和回车在HTML中会被等效为一个空格,所以HTML中要换段落就要用到<p>,<p>段落中也可以包含<p>段落 3.<center> 居中对齐标记,让段落或者文字相对于父标记居中显示 4.<pr> 预格式化标记,保留预先编排好的格式,即使很多个空格,也会全显示出来 5.<li> 列表…
1.格式标记 <br/> 强制换行标记 <p> 换段落标记 换段落,由于多个空格和回车在HTML中会被等效为一个空格,所以HTML中要换段落就要用<p>,<p>段落中也可以包含<p>段落! <center> 居中对齐标记 <pre> 预格式化标记 保留预先编排好的格式 <li> 列表项目标记 每个列表使用一个<li>标记 <ul> 无序列表标记 <ol> 有序列表标记 可以显…
经过今天一上午的修改,已经有个基础的框架了,其它功能只能是在实际使用中发现一个修改一个了. 以下是生成的结果示例: 相比昨天,几个Model都有修改,这里就不一一贴代码了,放个代码包上来,有需要的自己去查看. 整个代码的核心:生成序列化字符串,微软支持的并不好,不能缩进. static string GetSerializationString(string formatter, Type inputType, object input) { try { var serializerSettin…
<?xml version="1.0" encoding="UTF-8"?> <?eclipse version="3.4"?> <plugin> <extension point="org.eclipse.ui.actionSets"> <actionSet id="com.neusoft.unieap.workshop.exportDocument.actio…
在.net framework框架下可以使用WebApiTestClientWebApi生成WebAPI接口文档与方便接口测试用,而在DotnetCore却没有找到这个工具了,baidu查找一下发现有一个相类似的工具,它就是Swagger,和使用WebApiTestClientWebApi差不多的,这里Swagger配置过程整理如下:   一.下载Swashbuckle.AspNetCore NuGet下载安装Swashbuckle.AspNetCore   二.Startup.cs代码修改 1…
本文版权归博客园和作者吴双本人共同所有,转载和爬虫请注明博客园蜗牛原文地址,cnblogs.com/tdws   写在前面 请原谅我这个标题党,写到了第100篇随笔,说是深度优化,其实也并没有什么深度.源码也没怎么修改,如果你想使用WebApi Swagger文档,请先移步到上一篇的中度优化. 第一篇:ASP.NET WebApi 文档Swagger中度优化 http://www.cnblogs.com/tdws/p/6100126.html 第二篇:ASP.NET WebApi 文档Swash…
转载自 http://zzstudy.offcn.com/archives/6159 如何解决IIS7多域名绑定同一物理目录,设置不同的默认文档的问题? 因为在一个物理目录下只有一个web.config,并且IIS7把默认文档设置写在这里,导致所有域名的默认文档设置共享,很多人对此束手无策,甚至有人说这是IIS7的bug.其实IIS7不会比IIS6落后的,这个问题也很好解决,下面是解决方案: 1.进入%windir%\system32\inetsrv\config目录(%windir%即wind…
对于一些重要的word文档,出于防止资料被他人查看,或者防止文档被修改的目的,我们在选择文档保护时可以选择文档打开添加密码或者设置文档操作权限等,在下面的文章中将介绍如何使用类库Free Spire.Doc for .NET来加密.解密以及给文档设置操作权限等,主要分为以下几个要点来具体阐述 添加Word密码保护 解除Word密码保护 设置word文档操作权限 设置Word部分内容编辑权限 工具使用: 安装Free Spire.Doc之后,在程序中引用Spire.Doc.dll即可(dll可以在…
Swagger可以自动生成Api说明文档,并内置在线测试,通过NSwagStudio还可以自动生成Api客户端调用代码,以下为具体实现步骤 1.写一个简单的WebApi并加上注释 public class ValuesController : ApiController { /// <summary> /// 这是一个Post测试 /// </summary> /// <param name="para"></param> /// <…
今天在 IIS 7 多端口或域名绑定同一物理目录,设置不同的默认文档遇到问题:同一物理目录的多个站点修改任意一个站点默认文档都会一起更改. 原因:在同一个物理目录下只有一个 web.config,并且 IIS7 把默认文档设置写在这里,导致所有域名的默认文档设置共享. 解决方案: 比如我们把 www.ExampleA.com 和 www.ExampleB.com 两个域名都指向 E:\WebTest 文件目录,想把 www.ExampleA.com 的默认文档设为目录下的 indexA.html…
1.引用NuGet: Swashbuckle.AspNetCore.Swagger Swashbuckle.AspNetCore.SwaggerGen 或 <PackageReference Include="Swashbuckle.AspNetCore.Swagger" Version="1.1.0" /> <PackageReference Include="Swashbuckle.AspNetCore.SwaggerGen"…
IIS7多域名绑定同一物理目录,设置不同的默认文档是没办法设置的,因为在一个物理目录下只有一个web.config,并且IIS7把默认文档设置写在这里,导致所有域名的默认文档设置共享.解决方法:1.进入%windir%\system32\inetsrv\config目录(%windir%即windows的安装目录,比如c:\windows) 2.找到applicationHost.config文件,用文本编辑器打开,如果打不开就复制出来修改后再替换原来的文件(建议备份原文件,以防不测,这是工作习…
本文将一步步演示如何用swagger美化WebApi接口文档,为接口文档添加接口名称说明,为请求参数和返回数据结构字段含义添加注释说明 一.为WebApi项目安装Swagger 首先我们新建一个WebApi项目 图1(新建WebApi项目) 右击项目,选择管理NuGet程序包,搜索swagger,为WebApi安装swagger 图2(右击项目或者解决方案,选择管理NuGet程序包) 图2(在管理NuGet程序包中搜索Swagger) Swagger安装成功后,App_Start目录会多出一个S…
在一篇论文中需要将摘要和目录作为一部分设置罗马数字页码,正文部分设置阿拉伯数字页码. 大致效果如下图所示: 这里面用到了分节符,步骤如下: 1 :点击开始菜单栏下 显示/隐藏编辑标记 2:点击插入菜单栏下的页码,先为整个文档设置页码.此时整个文档按照1,2,... ,n这样显示页码. 3:在需要分别显示不同页面的中间部分设置分节符: 在两节之间的位置点击 布局 -> 分隔符 -> (分节符下的)下一页. 4:在第一页的页码位置设置页码,前面一节设置为罗马数字格式.(注:设置第一节时,选中起始页…
关于ASP.NET Web Api的HelpPage文档注释问题 以前我用微软的HelpPage来自动生成的webAPI帮助文档.在使用了一段时间后发现只能显示Controller上面写的注释文档内容.以前总以为是微软这个类库的bug.后来才明白了是由于我的设置不当. 微软的HelpPage类库 controller上的注释 AlarmRecodrdDto文档 我们可以很清楚的看到,返回的`AlarmRecodrdDto`并没有注释文档啊!可是我已经在类库的中写过了该代码的注释的.为毛就没有呢?…