zoukankan      html  css  js  c++  java
  • ASP.NET Web API 创建帮助页

    1. 安装 Microsoft.AspNet.WebApi.HelpPage 程序包

    Install-Package 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. 效果

    Help Page

    Help/Api/POST-api-Values

  • 相关阅读:
    函数对象
    函数的基本使用
    文件处理
    字符编码
    基本数据类型及内置方法二
    流程控制(if while for)
    Django中ajax的基本用法
    CBV之Django中View类部分源码分析
    前端基础之BOM和DOM
    css基础
  • 原文地址:https://www.cnblogs.com/xishuai/p/aspnet-web-api-creating-api-help-pages.html
Copyright © 2011-2022 走看看