ASP.NET Web API从注释生成帮助文档

ASP.NET Web API从注释生成帮助文档

默认情况下,ASP.NET Web API不从Controller的注释中生成帮助文档。如果要将注释作为Web API帮助文档的一部分,比如在帮助文档的Description栏目中显示方法注释中的summary,需要进行一些配置操作。

首先在Visual Studio中打开Web API项目的属性页,在Build设置页,选中XML document file,输入将要生成的XML文件放置的路径,比如:App_Data\OpenAPI.XML。

1460637926036.jpg

然后编译项目,就会在对应的路径下生成xml文件。

接着打开 Areas\HelpPage\App_Start\HelpPageConfig.cs 文件,取消 config.SetDocumentationProvider 代码的注释,修改一下路径:

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/OpenAPI.xml")));

然后重新编译,访问 /help 页面,就能看到效果了。

时间: 2024-10-10 01:09:48

ASP.NET Web API从注释生成帮助文档的相关文章

ASP.NET Web API根据代码注释生成Help文档

使用Visual Studio新建一个ASP.NET Web API项目,直接运行,查看Help文档可以看到如下的API帮助说明 如何在Description中显示描述. 1. 打开Controllers=>ValuesController,为每个API增加注释(Summary) public class ValuesController : ApiController { /// <summary> /// GET api/values /// </summary> ///

快速根据注释生成接口文档网页工具——Apidoc的使用教程

1,安装Node.js的npm工具环境: 如有不懂,请看我的博客:"https://blog.csdn.net/sinat_28371057/article/details/81612661" 2,npm环境搭好后,控制台运行命令: npm install apidoc -g 安装完成后显示如下界面: 2,在接口程序文件中添加apidoc文档注释 /** * @apiDefine userApiStr 用户接口文档 */ /** * @api {POST} /login 用户登录 *

webAPI 加注释生成帮助文档和测试demo

转自https://blog.csdn.net/a123_z/article/details/71078062 1:配置 接口注释. (1)配置生成xml的路径.我们在项目上面点右键→属性→生成标签页配置xml的路径. (2)在xml的读取路径:在Areas\HelpPage\App_Start\HelpPageConfig.cs里面配置xml的读取路径. config.SetDocumentationProvider(new XmlDocumentationProvider(HttpConte

ASP.NET 动态查找数据 并且生成xml文档 同时使用xslt转换为xhtml

前言 xsl是一门标签解析语言,很适合做动态网页的前台标签 www.bamn.cn 1 首先是aspx页面 添加一个输入框 按钮 还有一个用来显示解析后的xhtml代码的控件 <form id="form1" runat="server"> <div> <asp:TextBox ID="TextBox1" runat="server" TextMode="MultiLine"

DoNetCore Web Api 采用Swagger进行接口文档管理

第一步:创建API项目 步骤这里不说明 第二步:就是Nuget 包, 两种方式:1.工具->Nuget管理->程序包管理控制台 Install-Package Swashbuckle.AspNetCore 2.工具->Nuget管理->管理Nuget包...  或者右击项目... 输入 Swashbuckle.AspNetCore 第三步:全局配置,这里以最简单的配置为例 在Startup.cs 文件下 ConfigureService 下添加如下代码 services.AddSw

asp.net web api帮助文档的说明

为asp.net的mvc web api填写自己的帮助文档 1. 加入Help的area(能够通过命令行或其它方式加入) 命令行:Install-Package Microsoft.AspNet.WebApi.HelpPage NuGet搜索:HelpPage,找到Microsoft asp.net web api help page 2. 为api等加入凝视 3. 生成凝视为xml文件 4. 将xml赋予Help的configuration 在help的config文件里 HelpPageCo

01Getting Started---Getting Started with ASP.NET Web API 2入门WebApi2

HTTP 不只是为了生成 web 页面.它也是建立公开服务和数据的 Api 的强大平台.HTTP 是简单的. 灵活的和无处不在.你能想到的几乎任何平台有 HTTP 库,因此,HTTP 服务可以达到范围广泛的客户,包括浏览器. 移动设备和传统的桌面应用程序. ASP.NET Web API 是用于生成 web Api 在.NET 框架上的框架.在本教程中,您将使用 ASP.NET Web API 来创建 web API 返回的产品列表. 在本教程中使用的软件版本 视觉工作室 2013 年 Web

WebAPI使用多个xml文件生成帮助文档

一.前言 上篇有提到在WebAPI项目内,通过在Nuget里安装(Microsoft.AspNet.WebApi.HelpPage)可以根据注释生成帮助文档,查看代码实现会发现是基于解析项目生成的xml文档来作为数据源从而展示出来的.在我们的项目帮助文档需要的类(特指定义的Request和Response)与项目在同一个项目时是没有问题的,但是我们实际工作中会因为其他项目也需要引用该(Request和Response)时,我们会将其抽出来单独作为一个项目供其它调用来引用,这时,查看帮助文档不会报

【转】WebAPI使用多个xml文件生成帮助文档

来自:http://www.it165.net/pro/html/201505/42504.html 一.前言 上篇有提到在WebAPI项目内,通过在Nuget里安装(Microsoft.AspNet.WebApi.HelpPage)可以根据注释生成帮助文档,查看代码实现会发现是基于解析项目生成的xml文档来作为数据源从而展示出来的.在我们的项目帮助文档需要的类(特指定义的Request和Response)与项目在同一个项目时是没有问题的,但是我们实际工作中会因为其他项目也需要引用该(Reque