VS2019之WebAPI的创建与调用方法

一、使用VS2019创建WebAPI




使用ValuesController.cs来编写WebAPI的方法（重要）

WebApiConfig.cs的配置代码：注意访问方式，WebApi在访问时在主机名后加/api/,然后再加控件器、方法、参数，如：https://localhost:44325/api/values/Demo （post请求方式）
https://localhost:44325/api/values/wxs?name=张三 （get请求方式）

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web.Http;
using System.Web.Http.Cors;



namespace WebApplication1
{
    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {

           
          
            // Web API 路由
            config.MapHttpAttributeRoutes();

            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{Action}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
            //跨域配置
            config.EnableCors(new EnableCorsAttribute("*", "*", "*"));
        }
    }
}

RouteConfig.cs代码：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using System.Web.Routing;

namespace WebApplication1
{
    public class RouteConfig
    {
        public static void RegisterRoutes(RouteCollection routes)
        {
            routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

            routes.MapRoute(
                name: "Default",
                url: "{controller}/{action}/{id}",
                defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
            );
        }
    }
}

A、ValueController.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;
using WebApplication1.Models;

namespace WebApplication1.Controllers
{
    
    public class ValuesController : ApiController
    {
        // GET api/values
        public IEnumerable<string> Get()
        {
            return new string[] { "value1", "value2" };
        }

        // GET api/values/5
        public string Get(int id)
        {
            return "value";
        }

        // POST api/values
        public void Post([FromBody] string value)
        {
           
        }

        // PUT api/values/5
        public void Put(int id, [FromBody] string value)
        {
        }

        // DELETE api/values/5
        public void Delete(int id)
        {
        }

        [HttpPost]
        public string Demo([System.Web.Http.FromBody] Contact name)
        {
            string nn = name.Name;
            string result = string.Empty;
            result = "您的参数是：" + nn;
            return result;
        }
       
        [HttpGet]
        public string wxs(string name)
        {
            string result = string.Empty;
            result = "{Name:\"" + name + "\"}";
            return result;
        }

    }
}

二、get请求方式：
https://localhost:44325/api/Values/wxs?name=张三
三、post请求方式：使用Http模拟请求工具，如图填写内容：请求URL、Post数据
：
四、跨域配置：在WebCongfig.cs中<system.webServer>节中配置

<!--跨域配置-->
  <httpProtocol>
		  <customHeaders>
			  <!--响应类型 (值为逗号分隔的一个字符串，表明服务器支持的所有跨域请求的方法)-->
			  <add name="Access-Control-Allow-Methods" value="GET,POST,PUT,DELETE,OPTIONS"/>
			  <!--响应头设置（Content-Type：只限于三个值application/x-www-form-urlencoded、multipart/form-data、text/plain）-->
			  <add name="Access-Control-Allow-Headers" value="x-requested-with,content-type"/>
			  <!--如果设置 Access-Control-Allow-Origin:*，则允许所有域名的脚本访问该资源-->
			  <add name="Access-Control-Allow-Origin" value="*" />
			  <!--<add name="Access-Control-Allow-Origin" value="http://xxxxxxx1.com, http://xxxxxxx2.com" />  设置允许跨域访问的网址，如：localhost:44352等-->
		  </customHeaders>
	  </httpProtocol>

五、Application_Start()中配置跨域的方法：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http;
using System.Web.Mvc;
using System.Web.Optimization;
using System.Web.Routing;

namespace WebApplication1
{
    public class WebApiApplication : System.Web.HttpApplication
    {
        protected void Application_Start()
        {
            AreaRegistration.RegisterAllAreas();
            GlobalConfiguration.Configure(WebApiConfig.Register);
                  GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();
            FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
            RouteConfig.RegisterRoutes(RouteTable.Routes);
            BundleConfig.RegisterBundles(BundleTable.Bundles);
            WebApiConfig.Register(GlobalConfiguration.Configuration);//重要，在WebApi项目中App
           
        }
        /// <summary>
        /// 跨域设置
        /// </summary>
        protected void Application_BeginRequest()
        {
            //OPTIONS请求方法的主要作用：
            //1、获取服务器支持的HTTP请求方法；也是黑客经常使用的方法。
            //2、用来检查服务器的性能。如：AJAX进行跨域请求时的预检，需要向另外一个域名的资源发送一个HTTP OPTIONS请求头，用以判断实际发送的请求是否安全。
            if (Request.Headers.AllKeys.Contains("Origin") && Request.HttpMethod == "OPTIONS")
            {
                //表示对输出的内容进行缓冲，执行page.Response.Flush()时，会等所有内容缓冲完毕，将内容发送到客户端。
                //这样就不会出错，造成页面卡死状态，让用户无限制的等下去
                Response.Flush();
            }
        }
    }
}

秋风写淄博 业务联系与技术交流：QQ375172665