❶ 请问html的js调用webapi接口
引用jquery,有很方便的GET调用方法:
<!DOCTYPEhtml>
<html>
<head>
<metahttp-equiv="content-type"content="text/html;charset=UTF-8">
<metaname="viewport"content="width=device-width,initial-scale=1">
<!--src值为文件位置路径-->
<scripttype="text/javascript"charset="UTF-8"src="javascript/jquery-1.12.1.js"></script>
<title>测试案例</title>
<!--语法:jQuery.getJSON(url,data,success(data,status,xhr))-->
<scripttype="text/javascript"charset="UTF-8">
functiongetToken(){
$.getJSON("http://localhost/kdapi/api/access_token",{"id":111,"secret":2352532},function(result){
alert(result.access_token);
});
}
</script>
</head>
<body>
<buttononclick="getToken()"style="width:120px;height:60px;">获取Token</button>
</body>
</html>
❷ RESTful架构中的webapi
通过webAPI在server端开发一个借口,在client端调用此借口的完整过程。
(VS2010版本如果包括MVC4也可以创建webAPI,或者vs2012及以上版本)
运行环境:VS2017
开发语言:c#
一、server端
1.创建webapi项目,打开vs2017-文件-新建-项目。
2.在项目中添加Controllers和Models两个文件夹,分别用于存放控制器类和实体类。
在Controllers文件夹中添加API控制器类。
控制类添加完成后,会自动生成,GET,POST,PUT,DELETE四个方法。
通过地址确定方法:
get方式:http://IP地址:端口号/api/控制器名称
post方式:[HttpGet("方法标识名称")] http://IP地址:端口号/api/控制器名称/方法标识名称
添加一个方法,在方法中描述接口需要完成的操作以及返回值。
需要注意事项:
1)传进来参数的数据类型必须与接收的数据类型相同。
二、client端
1.添加控制台应用程序用来测试调用接口是否成功。
2.定义一个方法用来调用接口并返回数据。
3.定义一个restful接口帮助类。
❸ 有哪些webapi开发好用的工具
先定义一个简单的webapi,简单到差不多直接用vs2010自动生成的webapi代码。其中的TestModle是一个简单的class,如下public class TestModle { public string a { get; set; } public string b { get; set; } public string c { get; set; } }
❹ 如何测试webservice和websocket接口
WebSocket是html5新增加的一种通信协议,目前流行的浏览器都支持这个协议,例如Chrome,Safari,Firefox,Opera,IE等等,对该协议支持最早的应该是chrome,从chrome12就已经开始支持,随着协议草案的不断变化,各个浏览器对协议的实现也在不停的更新。该协议还是草案,没有成为标准,不过成为标准应该只是时间问题了,从WebSocket草案的提出到现在已经有十几个版本了,目前最新的是版本17,所对应的协议版本号为13,目前对该协议支持最完善的浏览器应该是chrome,毕竟WebSocket协议草案也是Google发布的。
1. WebSocket API简介
首先看一段简单的javascript代码,该代码调用了WebSockets的API。
[javascript] view plain
var ws = new WebSocket(“ws://echo.websocket.org”);
ws.onopen = function(){ws.send(“Test!”); };
ws.onmessage = function(evt){console.log(evt.data);ws.close();};
ws.onclose = function(evt){console.log(“WebSocketClosed!”);};
ws.onerror = function(evt){console.log(“WebSocketError!”);};
这份代码总共只有5行,现在简单概述一下这5行代码的意义。
第一行代码是在申请一个WebSocket对象,参数是需要连接的服务器端的地址,同http协议使用http://开头一样,WebSocket协议的URL使用ws://开头,另外安全的WebSocket协议使用wss://开头。
❺ 如何使用mvc实现webapi的增删改查
1.创建项目:visual C# —> ASP.NET MVC 4 web应用程序 模板—>web api;
2.注册路由:
路由表中的每一个条目都包含一个路由模板。这个Web API默认的路由模版是"api/{controller}/{id}"。在这个模版中,“api”是一个文字式路径片段,而{controller}和{id}则是占位符变量。
当Web API框架接收一个HTTP请求时,它会试图根据路由表中的一个路由模板来匹配其URI。如果无路由匹配,客户端会接收到一个404(未找到)错误。
3.linq to sql连接数据库
1.建立数据库建表
2.在models文件夹里面新建linq to sql类文件
3.工具->连接到数据库
4.将要用的表拖入设计区
5.获取数据库Getway。"linq to sql class"文件名+Datacontext实例化这个对象,数据表就会映射到一个集合属性中,personDataDataContext db = new personDataDataContext();
6.增删改查
增:
public Boolean Post([FromBody]UserInfo userInfo) {
personDataDataContext db = new personDataDataContext();
var s1 = new test2
{
UserName =userInfo.UserName, Id=userInfo.Id, Age=userInfo.Age
};
if (db.test2.SingleOrDefault<test2>(s => s.Id == userInfo.Id) == null)
{
db.test2.InsertOnSubmit(s1);
db.SubmitChanges();
return true;
} else {
return false;
}
}
删:
public bool Delete(int id)
{
personDataDataContext db = new personDataDataContext();
var deleteperson = db.test2.SingleOrDefault<test2>(s => s.Id == id);
if (deleteperson == null)
{
return false;
} else {
db.test2.DeleteOnSubmit(deleteperson);
db.SubmitChanges();
return true;
}
}
改:
public Boolean Put(int id, [FromBody]UserInfo userInfo)
{
personDataDataContext db = new personDataDataContext();
var editperson = db.test2.SingleOrDefault<test2>(s => s.Id == userInfo.Id);
if (editperson == null)
{
return false;
} else {
editperson.Age = userInfo.Age;
editperson.UserName = userInfo.UserName;
db.SubmitChanges();
return true;
}
查:
public IEnumerable<test2> Get()
{
personDataDataContext db = new personDataDataContext();
var query = from s in db.test2
orderby s.UserName
select s;
return query;
}
// GET api/values/5
public string Get(int id)
{
return "value";
}
这里我新建了一个userinfo类
public class UserInfo { public string UserName { get; set; } public int Id { get; set; } public int Age { get; set; } }
用来接收前端页面ajax请求中的data数据,s => s.Id == userInfo.Id是lamda表达式创建委托方法意思是在db.test2的person集合中查找某个person的Id与userinfo接收到的id相等的person对象
❻ 怎么把WebApi接口部署到IIS
用flashfxp 工具上传到服务器 前提是你需要有服务器上有操作空间权限的用户名和密码如果是ASP的 或者.NET的 传完用IIS配置网站文件夹安全也需要增加一个对应文件夹的用户 或者everyone用户 来给它写权限还要记得IIS配置里开启父路径。
❼ WebAPI系列之快速入门
前言
随着上位机开发技术的广泛应用,很多小伙伴会有上位机与MES等系统进行数据交互的需求,这时候,我们就需要了解WebAPI的相关技术。
什么是WebAPI?
WebAPI是一个简单的构建HTTP服务的新框架,用于对接各种客户端(浏览器,移动设备),在.Net平台上,WebAPI是一个开源的、理想的、构建REST-ful服务的技术。
WebAPI部署在哪里?
WebAPI部署在IIS中,用于给外部应用提供数据。
为什么要使用WebAPI?
WebAPI本质是网络应用程序接口,网络应用可以通过API接口,可以实现存储服务、消息服务、计算服务等能力,利用这些能力可以进行开发出强大功能的web应用。
创建WebAPI
1、打开VS2019,创建一个新项目,项目模板选择ASP.NET Web应用程序(.NET Framework),如下所示:
2、创建完成后,取一个项目名称,然后点击下一步,在下面的页面中,选择模板为Web API,如下所示:
3、创建项目需要一点时间,由于我们选择好了Web API,所以创建好的项目界面自动会添加好Models/Controllers/Views等文件夹,如下所示:
4、在Models文件夹下,创建一个实体类,如下所示:
5、在Controllers文件夹下,右击创建控制器,这里注意要选择Web API 2控制器模板,名称为THMonitorController,继承ApiController,如下所示:
6、在THMonitorController控制器中,创建一个实体集合对象,同时添加两个Get开头的方法,如下所示:
public class THMonitorController : ApiController
{
THMonitor[] THMonitors = new THMonitor[]
{
newTHMonitor(){Name="温度1",Value="22.3",Unit="℃",Desc="温度1"},
newTHMonitor(){Name="温度2",Value="22.1",Unit="℃",Desc="温度2"},
newTHMonitor(){Name="温度3",Value="32.3",Unit="℃",Desc="温度3"},
newTHMonitor(){Name="温度4",Value="22.3",Unit="℃",Desc="温度4"},
newTHMonitor(){Name="湿度1",Value="42.3",Unit="%",Desc="湿度1"},
newTHMonitor(){Name="湿度2",Value="42.1",Unit="%",Desc="湿度2"},
newTHMonitor(){Name="湿度3",Value="42.3",Unit="%",Desc="湿度3"},
newTHMonitor(){Name="湿度4",Value="42.3",Unit="%",Desc="湿度4"},
};
public IEnumerableGetAllTHMonitor()
{
returnTHMonitors;
}
public THMonitor GetTHMonitorByName(string name)
{
THMonitor contact = THMonitors.FirstOrDefault(item => item.Name == name);
if(contact == null)
{
throw new HttpResponseException(HttpStatusCode.NotFound);
}
returncontact;
}
7、这样,最简单的一个WebAPI项目就完成了,直接运行即可,运行地址为https://localhost:44382/。
Web API测试
使用Postman接口工具来进行测试。
Postman是一款功能强大的HTTP调试与模拟插件。获取安装包,后台回复 Postman
1、启动Postman之后,在地址栏输入https://localhost:44382/,如果要获取所有的数据,请求方式选择Get,地址栏后面加个api/THMonitor,点击Send,可以看到返回的数据,结果显示为JSON格式。
2、如果想要查询某个数据,可以加个参数,地址栏为https://localhost:44382/api/THMonitor?Name=温度1,查询结果如下所示:
3、地址栏格式可以参考项目中的WebApiConfig.cs文件:
我是新阁上位机开发的付老师,用我的专业,成就你的梦想!
-END-
❽ 如何使 WebAPI 自动生成漂亮又实用在线API文档
1.1 SwaggerUI
SwaggerUI 是一个简单的Restful API 测试和文档工具。简单、漂亮、易用(官方demo)。通过读取JSON 配置显示API. 项目本身仅仅也只依赖一些 html,css.js静态文件. 你可以几乎放在任何Web容器上使用。
1.2 Swashbuckle
Swashbuckle 是.NET类库,可以将WebAPI所有开放的控制器方法生成对应SwaggerUI的JSON配置。再通过SwaggerUI 显示出来。类库中已经包含SwaggerUI 。所以不需要额外安装。
2.快速开始
创建项目 OnlineAPI来封装网络音乐服务(示例下载) ,通过API可以搜索、获取音乐的信息和播放连接。
我尽量删除一些我们demo中不会用到的一些文件,使其看上去比较简洁。
WebAPI 安装 Swashbuckle
Install-Package Swashbuckle
代码注释生成文档说明。
Swashbuckle 是通过生成的XML文件来读取注释的,生成 SwaggerUI,JSON 配置中的说明的。
安装时会在项目目录 App_Start 文件夹下生成一个 SwaggerConfig.cs 配置文件,用于配置 SwaggerUI 相关展示行为的。如图:
将配置文件大概99行注释去掉并修改为
c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));
并在当前类中添加一个方法
/// <summary>
/// </summary>
/// <param name="name"></param>
/// <returns></returns>
protected static string GetXmlCommentsPath(string name)
{
return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name);
}
紧接着你在此Web项目属性生成选卡中勾选 “XML 文档文件”,编译过程中生成类库的注释文件
添加网络音乐 3个API
访问 http://<youhost>/swagger/ui/index,最终显示效果
我们通过API 测试API 是否成功运行
3.添加自定义HTTP Header
在开发移动端 API时常常需要验证权限,验证参数放在Http请求头中是再好不过了。WebAPI配合过滤器验证权限即可
首先我们需要创建一个 IOperationFilter 接口的类。IOperationFilter
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http;
using System.Web.Http.Description;
using System.Web.Http.Filters;
using Swashbuckle.Swagger;
namespace OnlineAPI.Utility
{
public class HttpHeaderFilter : IOperationFilter
{
public void Apply(Operation operation, SchemaRegistry
schemaRegistry, ApiDescription apiDescription)
{
if (operation.parameters == null) operation.parameters = new
List<Parameter>();
var filterPipeline =
apiDescription.ActionDescriptor.GetFilterPipeline();
//判断是否添加权限过滤器
var isAuthorized = filterPipeline.Select(filterInfo =>
filterInfo.Instance).Any(filter => filter is IAuthorizationFilter);
//判断是否允许匿名方法
var allowAnonymous =
apiDescription.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute>().Any();
if (isAuthorized && !allowAnonymous)
{
operation.parameters.Add(new Parameter
{
name = "access-key",
@in = "header",
description = "用户访问Key",
required = false,
type = "string"
});
}
}
}
}
在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码
c.OperationFilter<HttpHeaderFilter>();
添加Web权限过滤器
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Text;
using System.Web;
using System.Web.Http;
using System.Web.Http.Controllers;
using Newtonsoft.Json;
namespace OnlineAPI.Utility
{
/// <summary>
///
/// </summary>
public class AccessKeyAttribute : AuthorizeAttribute
{
/// <summary>
/// 权限验证
/// </summary>
/// <param name="actionContext"></param>
/// <returns></returns>
protected override bool IsAuthorized(HttpActionContext actionContext)
{
var request = actionContext.Request;
if (request.Headers.Contains("access-key"))
{
var accessKey = request.Headers.GetValues("access-key").SingleOrDefault();
//TODO 验证Key
return accessKey == "123456789";
}
return false;
}
/// <summary>
/// 处理未授权的请求
/// </summary>
/// <param name="actionContext"></param>
protected override void HandleUnauthorizedRequest(HttpActionContext actionContext)
{
var content = JsonConvert.SerializeObject(new {State = HttpStatusCode.Unauthorized});
actionContext.Response = new HttpResponseMessage
{
Content = new StringContent(content, Encoding.UTF8, "application/json"),
StatusCode = HttpStatusCode.Unauthorized
};
}
}
}
在你想要的ApiController 或者是 Action 添加过滤器
[AccessKey]
最终显示效果
4.显示上传文件参数
SwaggerUI 有上传文件的功能和添加自定义HTTP Header 做法类似,只是我们通过特殊的设置来标示API具有上传文件的功能
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http.Description;
using Swashbuckle.Swagger;
namespace OnlineAPI.Utility
{
/// <summary>
///
/// </summary>
public class UploadFilter : IOperationFilter
{
/// <summary>
/// 文件上传
/// </summary>
/// <param name="operation"></param>
/// <param name="schemaRegistry"></param>
/// <param name="apiDescription"></param>
public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
{
if (!string.IsNullOrWhiteSpace(operation.summary) && operation.summary.Contains("upload"))
{
operation.consumes.Add("application/form-data");
operation.parameters.Add(new Parameter
{
name = "file",
@in = "formData",
required = true,
type = "file"
});
}
}
}
}
在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码
c.OperationFilter<UploadFilter>();
API 文档展示效果
❾ Asp.netCore3.0 WebApi从0到1手摸手教你写【1】简单的webapi接口
Visual Studio 2019
.net core 3.0
具体步骤如下图:
此处我们选择API(新手不推荐选择空项目,选择API系统会为我们自动创建WebApi需要的一些配置文件等),Https配置这一项我们暂时不勾选,目前我们不配置Https。
F5运行项目,然后就可以看到微软为我们写好的一个天气预报示例webapi了,这里只有一个Get请求示例,返回值为json格式。
注意: services.AddControllers(); 和 endpoints.MapControllers(); 方法成对出现, 这是.net core3.0中的最新写法
ConfigureServices方法
用来向容器中注册服务,注册好的服务可以在其他地方进行调用.
Configure方法
用来配置中间件管道,即如何响应http请求.
1 右键删除系统默认创建的 WeatherForecastController.cs 和 WeatherForecast.cs
2 新建一个控制器,命名: UserController.cs
问题来了,为啥直接给打开 weatherforecast ,而且还404了,别急,往下看。
(┬_┬)怎么还是404?别急继续往下看
上面增加 action 虽然能达到想要的结果,但是每次新建一个 Controller 都有写个 action 万一要是忘记了又要忙乎半天,有没有一劳永逸的办法呢?
继续往下看:
1.首先去掉Controller里的 Route 和 ApiController
2.修改 Startup.cs ,增加路由模版:
今天就到这里,后期继续完善我们的webapi。
https://github.com/xiaxiaoqian/NetCore3.0-WebApi