zoukankan      html  css  js  c++  java
  • ASP.Net WebAPI中添加helppage帮助页面

    一、自动创建带帮助的WebAPI

    1、首先创建项目的时候选择WebAPI,如下图所示,生成的项目会自动生成帮助文档。

    2、设置调用XML文档的代码

    3、设置项目注释XML文档生成目录,项目——属性——生成——勾选生成XML文档——设置目录为App_Data

    4、Values控制器中的代码

    复制代码
     1     /// <summary>
     2     /// Values控制器
     3     /// </summary>
     4     public class ValuesController : ApiController
     5     {
     6        /// <summary>
     7        /// Get请求
     8        /// </summary>
     9        /// <returns></returns>
    10         public IEnumerable<string> Get()
    11         {
    12             return new string[] { "value1", "value2" };
    13         }
    14      }
    复制代码

    5、查看生成效果,启动项目——点API——查看帮助文档

    helpage

    Help/Api/GET-api-Values

    二、在已有项目中添加帮助页

    1、新建一个普通的webapi项目——在nuget中添加Microsoft.AspNet.WebApi.HelpPage

    2. 注册 Area

    protected void Application_Start()
    {
        AreaRegistration.RegisterAllAreas();
    }

    3. HelpPageConfig 启用 SetDocumentationProvider

     WebApplication/Areas/HelpPage/App_Start/HelpPageConfig.cs 目录下,找到下面代码,并取消注释(App_Data 改为 bin):

    public static void Register(HttpConfiguration config)
    {
        //// Uncomment the following to use the documentation from XML documentation file.
        config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/bin/XmlDocument.xml")));
    }

    4. WebApplication Build 配置 XmlDocument 输出路径

    5. ValuesController 代码

    复制代码
    /// <summary>
    /// Values控制器
    /// </summary>
    public class ValuesController : ApiController
    {
        ........
    
        /// <summary>
        /// POST 操作
        /// </summary>
        /// <param name="value">value值</param>
        public void Post([FromBody]string value)
        {
        }
    }
    复制代码

    6. 效果

  • 相关阅读:
    「Luogu」2831愤怒的小鸟 (DFS+dp)
    LeetCode习题集
    递归的时间复杂度你真的懂吗?不是所有的二分递归都是logn级别
    [数据结构篇]谈一谈优先队列吧!
    论文爱好者(我不是)的福利
    Python 读微博留言进行情感分析(文本分类)
    python 多进程中的p.apply_async()
    记录本科论文开题报告修改过程
    KMP字符串匹配算法
    Pandas Timedelta
  • 原文地址:https://www.cnblogs.com/daxia/p/5385723.html
Copyright © 2011-2022 走看看