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>
    /// <returns></returns>
    public IEnumerable<string> Get()
    {
        return new string[] { "value1", "value2" };
    }

    /// <summary>
    /// GET api/values/5
    /// </summary>
    /// <param name="id"></param>
    /// <returns></returns>
    public string Get(int id)
    {
        return "value";
    }

    /// <summary>
    /// POST api/values
    /// </summary>
    /// <param name="value"></param>
    public void Post([FromBody]string value)
    {
    }

    /// <summary>
    /// api/values/5
    /// </summary>
    /// <param name="id"></param>
    /// <param name="value"></param>
    public void Put(int id, [FromBody]string value)
    {
    }

    /// <summary>
    /// api/values/5
    /// </summary>
    /// <param name="id"></param>
    public void Delete(int id)
    {
    }
}

2. 打开项目的属性页=>Build,钩选Output=>XML documentation file:并输入存放项目注释文档的路径。

3. 修改如下代码

Areas=>HelpPage=>App_Start=>HelpPageConfig.cs,取消该行注释

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

注意路径必须和上面的自己配置的路径一致。

4. 重新生成项目,在App_Data下会生成XmlDocument.xml文件

5. 再次查看Help页,会发现API的注释已经增加。

时间: 2024-10-07 14:35:48

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

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. 1

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

asp.net core中使用Swashbuckle.AspNetCore生成接口文档 Swashbuckle.AspNetCore:swagger的asp.net core实现,本文使用版本为v1.1.0项目地址:https://github.com/domaindrivendev/Swashbuckle.AspNetCore仔细看了下readme,发现在百度找半天的东西其实readme里面就有... 开局一张图,然后开始编,一些基本的asp.net core东西就不再赘述,本文只对Swash

快速根据注释生成接口文档网页工具——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 用户登录 *

Java Web项目中使用Freemarker生成Word文档

Web项目中生成Word文档的操作屡见不鲜,基于Java的解决方案也是很多的,包括使用Jacob.Apache POI.Java2Word.iText等各种方式,其实在从Office 2003开始,就可以将Office文档转换成XML文件,这样只要将需要填入的内容放上${}占位符,就可以使用像Freemarker这样的模板引擎将出现占位符的地方替换成真实数据,这种方式较之其他的方案要更为简单. 下面举一个简单的例子,比如在Web页面中填写个人简历,然后点击保存下载到本地,效果图如下所示. 打开下

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

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

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

http://www.cnblogs.com/idoudou/p/xmldocumentation-for-web-api-include-documentation-from-beyond-the-main.html 一.前言 上篇有提到在WebAPI项目内,通过在Nuget里安装(Microsoft.AspNet.WebApi.HelpPage)可以根据注释生成帮助文档,查看代码实现会发现是基于解析项目生成的xml文档来作为数据源从而展示出来的.在我们的项目帮助文档需要的类(特指定义的Req

生成JavaDoc文档

JavaDoc是一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API,易读且清晰明了.在简略介绍JavaDoc写法之后,再看一下在Intellij Idea 中如何将代码中的注释生成HTML文档. java中的注释有三种: 单行注释:在IDEA中快捷键为Ctrl+/ 多行注释:在IDEA中快捷键为Ctrl+Shift+/ 文档注释: @author 作者名 @version 版本号 @since 指明需要最早使用的jdk版本 @param 参数名 @return 返回值情况