WebAPI 服务创建帮助文档

2017-09-30 本文已影响55人凌雲木

当创建一个服务接口，最好配套的创建一个接口帮助说明，这样的话，客户端调用接口时就会一目了然，知道接口如何调用。这个帮助说明文档如能自动随着接口的更新而更新，那就最好不过了。在WebAPI中就可以非常容易的创建这样一个接口的帮助说明，并能随着API接口自动更新。

创建步骤：

1 创建WebAPI服务
2 添加接口帮助设置
3 发布API服务，帮助文档也一同被发布

一创建WebAPI服务

1
新建WebAPI项目

image.png

２添加接口

  public class ValuesController : ApiController
    {
        
        UserInfoDal dal = new UserInfoDal();
       
        /// <summary>
        /// 查询所有人员信息
        /// </summary>
        /// <returns></returns>
        public IEnumerable<Userinfo> GetUserData()
        {
            List<Userinfo> sermodel = new List<Userinfo>();
            sermodel = dal.GetAllUserInfo();          
            return sermodel;
        }            
        /// <summary>
        /// 根据用户ID查询用户信息
        /// </summary>
        /// <returns></returns>
        public IHttpActionResult UpdateList(int id)  
        {
            Userinfo x = dal.GetUserInfo(id);
            return Ok(x);
        }
        /// <summary>
        /// 修改信息的
        /// </summary>
        /// <param name="model"></param>
        /// <returns></returns>     
        public IHttpActionResult UpdateUserInfo(Userinfo model)
        {
            if (dal.UpdateUserInfo(model))
            {
                return Json(new { success = "成功" });
            }
            return Json(new { success = "失败" });
        }       
         /// <summary>
         /// 删除用户
         /// </summary>
         /// <param name="id"></param>
         /// <returns></returns>
        public IHttpActionResult Delete(int id)
        {
            if (dal.DeleteUserInfo(id))
            {
                return Ok(1);
            }
            else
            {
                return Ok(0);
            }
        }
      
        /// <summary>
        /// 分页查询
        /// </summary>
        /// <param name="PageNumber">当前页码</param>
        /// <param name="PageSize">每页大小</param>
        /// <returns></returns>
        public IHttpActionResult Paging(int PageNumber, int PageSize)
        {
            int TotalItemCount = 0;//总条数
            int TotalPageCount = 0;//总页数
            List<Userinfo> list = new List<Userinfo>();
            // list = dal.GetUserInfoByPage(PageNumber, PageSize, out TotalItemCount, out TotalPageCount);
            list = dal.GetUserInfoByPage(PageNumber: PageNumber, PageSize: PageSize, TotalItemCount: out TotalItemCount, TotalPageCount: out TotalPageCount);
            return Json(new { model = list, TotalItemCount = TotalItemCount, TotalPageCount = TotalPageCount });
        }
      
        #region 添加
        /// <summary>
        /// 添加用户
        /// </summary>
        /// <param name="model">用户类对象</param>
        /// <returns></returns>
        public IHttpActionResult AddPage(Userinfo model)
        {

            bool b = dal.AddUser(model);
            if (b)
            {
                return Ok(new { success = "成功" });
            }
            return Ok(new { success = "失败" });
        }
        #endregion
    }

二添加接口帮助设置

image.png

1把Areas 文件下的类HelpPageConfig的
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml"))); 这句代码反注释
2右键项目属性，点击生成，勾选XML文档文件，并修改