【WEB API项目实战干货系列】

上一篇: 【WEB API项目实战干货系列】- Web API 2入门(一)

这一篇我们主要介绍如何做API帮助文档，给API的调用人员介绍各个 API的功能, 输入参数，输出参数, 以及在线测试 API功能(这个也是方便我们自己开发调试)

我们先来看看我们的API最终帮助文档及在线测试最终达到的效果:

概要图

GET API

添加产品API:

删除产品 API

接下来我们动手来实现上面的功能

给所有API添加注释信息

代码如下

[RoutePrefix("api/products")]  public class ProductController : ApiController  {    /// <summary>    /// 产品分页数据获取    /// </summary>    /// <returns></returns>    [HttpGet, Route("product/getList")]    public Page<Product> GetProductList()    {      throw new NotImplementedException();    }    /// <summary>    /// 获取单个产品    /// </summary>    /// <param name="productId"></param>    /// <returns></returns>    [HttpGet, Route("product/get")]    public Product GetProduct(Guid productId)    {      throw new NotImplementedException();    }    /// <summary>    /// 添加产品    /// </summary>    /// <param name="product"></param>    /// <returns></returns>    [HttpPost, Route("product/add")]    public Guid AddProduct(Product product)    {      throw new NotImplementedException();    }    /// <summary>    /// 更新产品    /// </summary>    /// <param name="productId"></param>    /// <param name="product"></param>    [HttpPost, Route("product/update")]    public void UpdateProduct(Guid productId, Product product)    {      throw new NotImplementedException();    }    /// <summary>    /// 删除产品    /// </summary>    /// <param name="productId"></param>    [HttpDelete, Route("product/delete")]    public void DeleteProduct(Guid productId)    {      throw new NotImplementedException();    }  }

原标题：【WEB API项目实战干货系列】

关键词：web