搭建简单的Web API项目、Web API的调用方式

一、创建Web API

1、Create a New Web API Project
创建新的Web API项目

Start by running Visual Studio 2010 and select New Project from the Start page. Or, from the File menu, select New and then Project.
启动VS 2012，并在“开始页”选择“新项目”。或从“文件”菜单选择“新建”，然后选择“项目”。

在“模板”面板中选择“已安装模板”，并展开“Visual C#”节点。选择该节点下的“Web”。在项目模板列表中选择“ASP.NET MVC 4 Web应用程序”。

在“新的ASP.NET MVC 4项目”对话框中选择“Web API”

二、Web API路由与动作

1、路由设置

    找到App_Start文件夹下WebApiConfig.cs文件,修改为下面设置

public static void Register(HttpConfiguration config)
        {
            config.Routes.MapHttpRoute(
                name: "PayOrderSendWifi", //此名称可随意设置，没用到
                routeTemplate: "api/{controller}/{id}",

              defaults: new
              {
                  id = RouteParameter.Optional,
              }
            );
            //直接xml文件排除
            config.Formatters.Remove(config.Formatters.XmlFormatter);


        }

三、创建Web API方法

1、新建一个控制器,添加一个POST请求方法

[HttpPost]
        public ResponseSignDTO UpdateUseTimeBySign(RequestWiFiDTO reqDTO)
        {
            ResponseSignDTO dto = new ResponseSignDTO();
            
                try
                {
                   //要执行的方法..................
                }
                catch (Exception ex)
                {
                }
           
            return dto;
        }

1、添加返回（响应）类

 /// <summary>
    /// 响应类
    /// </summary>
    public class ResponseSignDTO
    {
        /// <summary>
        /// 错误消息
        /// </summary>
        public ErrorMessage ErrorMessage { get; set; }

    }

2、添加请求类

 public class RequestWiFiDTO
    {
  /// <summary>
        /// 用户编号
        /// </summary>
        public int UserID { get; set; }
 }

3、消息类

 /// <summary>
    /// 消息类
    /// </summary>
    public class ErrorMessage
    {
    
        public int ID { get; set; }
 
        public string Message { get; set; }
        public static ErrorMessage Succeed()
        {
            ErrorMessage dto = new ErrorMessage();
            dto.ID = 0;
            dto.Message = "成功";
            return dto;
        }
        public static ErrorMessage Error(string errorMessage)
        {
            ErrorMessage dto = new ErrorMessage();
            dto.ID = 1;
            dto.Message = errorMessage;
            return dto;
        }
}
 /// <summary>
    /// 响应类
    /// </summary>
    public class ResponseDTO
    {
        /// <summary>
        /// 错误消息
        /// </summary>
        public ErrorMessage ErrorMessage { get; set; }
    }

2、添加一个Get请求方法

 [HttpGet]
        public ResponseDTO PayOrderSendWifiDTO(int UserID,int Days)
        {
            ResponseDTO respDTO = new ResponseDTO();
                try
                {
           //要执行的方法..................
                }
                catch (Exception ex)
                {
                }
           
            return respDTO;
        }

四、调用方式

1、调用POST方法:使用Chrome流量器的PostMan工具。

前端模拟发送数据/调试的好工具：Chrome下的Postman-REST Client

下载地址 https://chrome.google.com/webstore/search/postman-REST%20Client

PostMan设置：

①、Headers

Content-Type   application/json

Accept              textml,application/xml,application/xhtml+xml,textml;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5

2、调用Get方法:

http://localhost:3553/PayOrderSendWifi?UserID=8&Days=5