ToB企服应用市场:ToB评测及商务社交产业平台

标题: [入门一]C# webApi创建、与发布、部署、api调用 [打印本页]
作者: 风雨同行    时间: 2024-10-10 05:59
标题: [入门一]C# webApi创建、与发布、部署、api调用
一.创建web api项目
1.1、项目创建






MVC架构的话，它会有view-model-control三层，在web api中它的前端和后端是分离的，以是只在项目中存在model-control两层


1.2、修改路由
打开App_Start文件夹下，WebApiConfig.cs ,修改路由，加上{action}/ ，这样就可以在api接口中通过接口函数名，来导向我们希望调用的api函数，否则，只能通过controller来导向，就大概会造成有雷同参数的差别名函数，冲突。此中，{id}是api接口函数中的参数。
 
默认路由配置信息为：【默认路由模板无法满意针对一种资源一种请求方式的多种操作。】
WebApi的默认路由是通过http的方法（get/post/put/delete）去匹配对应的action，也就是说webapi的默认路由并不需要指定action的名称
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Web.Http;
  6. namespace WebAPI
  7. {
  8.     public static class WebApiConfig
  9.     {
  10.         public static void Register(HttpConfiguration config)
  11.         {
  12.             // Web API 配置和服务
  14.             // Web API 路由
  15.             config.MapHttpAttributeRoutes();
  17.             config.Routes.MapHttpRoute(
  18.                 name: "DefaultApi",
  19.                 //修改路由，加上{action}/ ，这样就可以在api接口中通过接口函数名，来导向我们希望调用的api函数，
  20.                 //否则，只能通过controller来导向，就可能会造成有相同参数的不同名函数，冲突。其中，{id}是api接口函数中的参数
  21.                 routeTemplate: "api/{controller}/{action}/{id}",
  22.                 defaults: new { id = RouteParameter.Optional }
  23.             );
  24.         }
  25.     }
  26. }
复制代码

二.测试案例
写一个测试的api函数，并开始实验(不调试)

2.1、我们在model文件夹中添加一个类movie



  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Web;
  6. namespace WebAPI.Models
  7. {
  8.     public class movie
  9.     {
  11.         public string name { get; set; }
  12.         public string director { get; set; }
  13.         public string actor { get; set; }
  14.         public string type { get; set; }
  15.         public int price { get; set; }
  19.     }
  20. }
复制代码

2.1.2、我们在model文件夹中添加一个类Product
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Web;
  6. namespace WebAPI.Models
  7. {
  8.     public class Product
  9.     {
  11.         public int Id { get; set; }
  12.         public string Name { get; set; }
  13.         public string Category { get; set; }
  14.         public decimal Price { get; set; }
  18.     }
  19. }
复制代码






2.2、在controller文件夹下添加web api控制器，定名改为TestController







  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Net;
  5. using System.Net.Http;
  6. using System.Web.Http;
  7. using WebAPI.Models;
  9. namespace WebAPI.Controllers
  10. {
  11.     public class TestController : ApiController
  12.     {
  15.         movie[] mymovie = new movie[]
  16.         {
  17.             new movie { name="海蒂和爷爷",director="阿兰.葛斯彭纳",actor="阿努克",type="动漫",price=28},
  18.             new movie { name="云南虫谷",director="佚名",actor="潘粤明",type="惊悚",price=32},
  19.             new movie { name="沙海",director="佚名",actor="吴磊",type="惊悚",price=28},
  20.             new movie { name="千与千寻",director="宫崎骏",actor="千寻",type="动漫",price=28}
  21.         };
  22.         public IEnumerable<movie> GetAllMovies()
  23.         {
  24.             return mymovie;
  26.         }
  27.         public IHttpActionResult GetMovie(string name)    //异步方式创建有什么作用
  28.         {
  29.             var mov = mymovie.FirstOrDefault((p) => p.name == name);
  30.             if (mymovie == null)
  31.             {
  32.                 return NotFound();
  33.             }
  34.             return Ok(mymovie);
  35.         }
  41.     }
  42. }
复制代码
这样就完成了一个web api实例的编写

2.2.2、在controller文件夹下添加web api控制器，定名改为productsController
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Net;
  5. using System.Net.Http;
  6. using System.Web.Http;
  7. using WebAPI.Models;
  9. namespace WebAPI.Controllers
  10. {
  11.     public class productsController : ApiController
  12.     {
  14.         Product[] products = new Product[]
  15.         {
  16.             new Product { Id = 1, Name = "Tomato Soup", Category = "Groceries", Price = 1 },
  17.             new Product { Id = 2, Name = "Yo-yo", Category = "Toys", Price = 3.75M },
  18.             new Product { Id = 3, Name = "Hammer", Category = "Hardware", Price = 16.99M }
  19.         };
  21.         public IEnumerable<Product> GetAllProducts()
  22.         {
  23.             return products;
  24.         }
  26.         public IHttpActionResult GetProduct(int id)
  27.         {
  28.             var product = products.FirstOrDefault((p) => p.Id == id);
  29.             if (product == null)
  30.             {
  31.                 return NotFound();
  32.             }
  33.             return Ok(product);
  34.         }
  39.     }
  40. }
复制代码

2.2.3、在controller文件夹下添加web api控制器，定名改为MyController
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Net;
  5. using System.Net.Http;
  6. using System.Web.Http;
  8. namespace WebAPI.Controllers
  9. {
  10.     public class MyController : ApiController
  11.     {
  14.         [HttpGet]
  15.         public string MyExample(string param1, int param2)
  16.         {
  17.             string res = "";
  18.             res = param1 + param2.ToString();
  19.             //这边可以进行任意操作，比如数据存入或者取出数据库等
  20.             return res;
  21.         }
  26.     }
  27. }
复制代码








三.当地调试
3.1 运行调试，以当地 localhost（或127.0.0.1）形式访问
①点击工具栏【IIS Express】

②浏览地址输入接口，看是否可以访问
localhost:44381/api/products/GetAllProducts
注意：
这里的路径是写你的控制器前缀名称（Control文件下的productsController控制器文件的前缀）


https://localhost:44381/api/Test/GetAllMovies


2）直接在浏览器中调试也行

想要调试的值，可以将WebApiConfig.cs的代码修如下
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Web.Http;
  6. namespace WebAPI
  7. {
  8.     public static class WebApiConfig
  9.     {
  10.         public static void Register(HttpConfiguration config)
  11.         {
  12.             // Web API 配置和服务
  14.             // Web API 路由
  15.             config.MapHttpAttributeRoutes();
  17.             config.Routes.MapHttpRoute(
  18.                 name: "DefaultApi",
  19.                 //修改路由，加上{action}/ ，这样就可以在api接口中通过接口函数名，来导向我们希望调用的api函数，
  20.                 //否则，只能通过controller来导向，就可能会造成有相同参数的不同名函数，冲突。其中，{id}是api接口函数中的参数
  21.                 routeTemplate: "api/{controller}/{action}/{id}",
  22.                 defaults: new { id = RouteParameter.Optional }
  23.             );
  26.             //去掉xml返回格式、设置json字段命名采用
  27.             var appXmlType =
  28.                 config.Formatters.XmlFormatter.SupportedMediaTypes.FirstOrDefault(t => t.MediaType == "application/xml");
  29.             config.Formatters.XmlFormatter.SupportedMediaTypes.Remove(appXmlType);
  35.         }
  36.     }
  37. }
复制代码

ok，显示乐成
localhost:44381/api/My/MyExample?param1=&param2=2


WebApi项目实例3-1

3-1 (1)新添加到控制器UserInfoController,
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Net;
  5. using System.Net.Http;
  6. using System.Web.Http;
  7. using WebAPI.Models;
  9. namespace WebAPI.Controllers
  10. {
  11.     public class UserInfoController : ApiController
  12.     {
  14.         //检查用户名是否已注册
  15.         private ApiTools tool = new ApiTools();
  17.         //  [HttpPost]
  19.         [HttpGet]
  20.         public HttpResponseMessage CheckUserName(string _userName)
  21.         {
  22.             int num = UserInfoGetCount(_userName);//查询是否存在该用户
  23.             if (num > 0)
  24.             {
  25.                 return tool.MsgFormat(ResponseCode.操作失败, "不可注册/用户已注册", "1 " + _userName);
  26.             }
  27.             else
  28.             {
  29.                 return tool.MsgFormat(ResponseCode.成功, "可注册", "0 " + _userName);
  30.             }
  31.         }
  33.         private int UserInfoGetCount(string username)
  34.         {
  35.             //return Convert.ToInt32(SearchValue("select count(id) from userinfo where username='" + username + "'"));
  36.             return username == "admin" ? 1 : 0;
  37.         }
  43.     }
  44. }
复制代码

添加返回（响应）类ApiTools
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Net.Http;
  5. using System.Text.RegularExpressions;
  6. using System.Web;
  8. namespace WebAPI.Models
  9. {
  10.     //添加返回（响应）类
  11.     public class ApiTools
  12.     {
  13.         private string msgModel = "{{"code":{0},"message":"{1}","result":{2}}}";
  14.         public ApiTools()
  15.         {
  16.         }
  17.         public HttpResponseMessage MsgFormat(ResponseCode code, string explanation, string result)
  18.         {
  19.             string r = @"^(\-|\+)?\d+(\.\d+)?$";
  20.             string json = string.Empty;
  21.             if (Regex.IsMatch(result, r) || result.ToLower() == "true" || result.ToLower() == "false" || result == "[]" || result.Contains('{'))
  22.             {
  23.                 json = string.Format(msgModel, (int)code, explanation, result);
  24.             }
  25.             else
  26.             {
  27.                 if (result.Contains('"'))
  28.                 {
  29.                     json = string.Format(msgModel, (int)code, explanation, result);
  30.                 }
  31.                 else
  32.                 {
  33.                     json = string.Format(msgModel, (int)code, explanation, """ + result + """);
  34.                 }
  35.             }
  36.             return new HttpResponseMessage { Content = new StringContent(json, System.Text.Encoding.UTF8, "application/json") };
  37.         }
  38.     }
  41.     public enum ResponseCode
  42.     {
  43.         操作失败 = 00000,
  44.         成功 = 10200,
  45.     }
  49. }
复制代码

3-1 (2)当地调试，调用Web API接口
运行调试，以当地 localhost（或127.0.0.1）形式访问
①点击工具栏【IIS Express】
②浏览地址输入接口，看是否可以访问

https://localhost:44381/api/UserInfo/CheckUserName?_userName=wxd





3.2 运行调试，以当地IP（192.168.6.152）形式访问
127.0.0.1是回路地址，来查验本机TCP/IP协议栈，实际使用过程中服务端不在本机，是外部地址，要用IP地址测试。
外部用户采用IP+端标语访问，如下图浏览器访问不了，400错误。
 


办理方案：
因为 IIS 7 采用了更安全的 web.config 管理机制，默认情况下会锁住配置项不答应更改。
以管理员身份运行下令行【此处不要操作】

  1. C:\windows\system32\inetsrv\appcmd unlock config -section:system.webServer/handlers
复制代码





假如modules也被锁定，再运行
  1. C:\windows\system32\inetsrv\appcmd unlock config -section:system.webServer/modules
复制代码













客户端程序：调用接口分为以下几种情况：
通过Javascript 和 jQuery 调用 Web API
右键资源管理器办理方案下面的项目，添加-新建项



将index.html内容替换成：
  1. <!DOCTYPE html>
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4.     <title>Product App</title>
  5. </head>
  6. <body>
  8.     <div>
  9.         <h2>All Products</h2>
  10.         <ul id="products" />
  11.     </div>
  12.     <div>
  13.         <h2>Search by ID</h2>
  14.         <input type="text" id="prodId" size="5" />
  15.         <input type="button" value="Search" onclick="find();" />
  16.         <p id="product" />
  17.     </div>
  19.     <script src="https://ajax.aspnetcdn.com/ajax/jQuery/jquery-2.0.3.min.js"></script>
  20.     <script>
  21.     var uri = 'api/Products';
  23.     $(document).ready(function () {
  24.       // Send an AJAX request
  25.       $.getJSON(uri)
  26.           .done(function (data) {
  27.             // On success, 'data' contains a list of products.
  28.             $.each(data, function (key, item) {
  29.               // Add a list item for the product.
  30.               $('<li>', { text: formatItem(item) }).appendTo($('#products'));
  31.             });
  32.           });
  33.     });
  35.     function formatItem(item) {
  36.       return item.Name + ': $' + item.Price;
  37.     }
  39.     function find() {
  40.       var id = $('#prodId').val();
  41.       $.getJSON(uri + '/' + id)
  42.           .done(function (data) {
  43.             $('#product').text(formatItem(data));
  44.           })
  45.           .fail(function (jqXHR, textStatus, err) {
  46.             $('#product').text('Error: ' + err);
  47.           });
  48.     }
  49.     </script>
  50. </body>
  51. </html>
复制代码







四.发布web api 并部署

4.1、首先，右键项目，选择发布：











到这里，程序已经发布到指定的路径下了（这里的路径，可以是本机的文件夹，也可以是服务器上的ftp路径）


4.2、我们还剩末了一步，就是，在IIS上，把发布的服务端程序挂上去，不说了，直接上图：
打开iis，选中网站，右键 添加网站， 


 好了，服务端程序发布并部署完成。
这个WebAPI就是刚刚我们部署好的，点击下图右侧的浏览*91(http)，会打开网页


































































免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。



欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4