.NETWebAPI项⽬⾃动⽣成接⼝⽂档和测试页⾯
⼀、⾃动创建带帮助的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)
{aspnet和net的区别
Uncomment the following to use the documentation from XML documentation file.
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/l")));
}
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. 效果

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。