• Web API中的Help Page


    一、自动创建带帮助的WebAPI

    第一步  创建项目的时候选择WebAPI

    如下图所示,生成的项目会自动生成帮助文档

    第二步  设置调用XML文档的代码

    第三步 设置项目注释XML文档生成目录

    项目——属性——生成——勾选生成XML文档——设置目录为App_Data

    第四步 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      }
    复制代码

    第五步  查看生成效果

    启动项目——点API——查看帮助文档

    Help/Api/GET-api-Values

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

    第一步  添加Microsoft.AspNet.WebApi.HelpPage

    第二步  注册 Area

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

    第三步  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")));
    }
    复制代码

    第四步 WebApplication Build 配置 XmlDocument 输出路径

    第五步 ValuesController 代码

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

    第六步  查看效果

    注:本文纯拷贝,原文地址https://www.cnblogs.com/enternal/p/4722664.html

  • 相关阅读:
    类与类之间的关系图
    UML介绍
    数据建模
    状态图
    部署图
    用例图
    业务建模
    时序图
    postgresql 维护手册
    ashx文件的使用(转)
  • 原文地址:https://www.cnblogs.com/wyy1234/p/9494633.html
Copyright © 2020-2023  润新知