MES开发与应用 课件 3.11 工业管理软件开发基础-Api接口的开发实现

3.11Api接口的开发实现深圳市信息职业技术学院目

录接口介绍01Api接口的定义02Api接口的开发和测试03Api接口的调用04知识回顾行为的使用场景；行为的脚本模板；行为的开发步骤；行为的开发示例。学习目标通过本节学习可以：掌握Api接口的定义；掌握Api接口的开发与调试；掌握接口卡的编写；了解接口的介绍；了解Api接口的调用；01接口介绍接口介绍接口介绍WebApi是基于HTTP协议，无状态的网络应用程序接口。数据格式为纯文本，也可以被WebAPI的MediaTypeFormatter换成Json、XML或者任何你想转换的格式，常用Json格式。是一个轻量级框架，非常适合移动端客户端服务。常用方式：①Get②Post③Put④DeleteWebServer是基于Soap协议，有状态的网络应用程序接口。数据格式为XML。是一个平台独立的，松耦合的，自包含的、基于可编程的web的应用程序，用于开发分布式的互操作的应用程序。常用方式：①Http请求②RFC调用③服务引用④代理服务常用方式：①提供数据库的连接地址并分配指定用户权限②提供连接服务：Oracle的DBLink，Sqlserver的linkedserver接口介绍接口介绍所有的WebService都是WebAPI，但所有的WebAPI并不是WebService。两者都是走HTTP协议的，SOAP协议也是基于HTTP协议的。但是WebServer的数据格式只能是XML，而WebApi是可以多种格式的，这就导致我们可以用WebApi的方式调用WebServer接口。WebService更加适合为端到端的场景提供服务，WebAPI则更加适合为应用到应用的场景提供服务。02Api接口的定义Api接口的定义Api接口的定义接口协议RestFulAPI方法名Login请求方式（Method）POST参数形式（ContentType）application/json描述第三方用户调用此接口获取数据参数{"ApiType":

"AuthenticationController",

"Parameters":

[

{

"Value":

"str"

},

{

"Value":

"str"

}

],

"Method":

"Login",

"Context":

{}}Api接口的定义Api接口的定义接口协议RestFulAPI参数描述参数内容需符合JSON格式，JSON串中的键仅允许26个小写英文字母、阿拉伯数字和下划线，且必须以小写字母开头，当键由多个单词组成时，单词与单词之间通过下划线进行连接，如未特别说明，本规范中定义的各字段的命名不能修改，最大封装Json包100KB。ApiType：控制器名称Parameters：参数Method：方法Context：内容返回值成功：{

"Success":

true,

"Message":

null,

"Result":

0,

"Context":

{

"Ticket":

"XXX"

}

}失败：{

"Success":

false,

"Message":

“错误信息”,

"Result":

1,

"Context":

{

"Ticket":

""

}

}Api接口的定义Api接口的定义接口协议RestFulAPI返回值描述Json格式，Success是否成功：true成功，false失败；Message错误信息；Result返回状态，0成功，1失败；Context内容：Ticket是凭证，在登录成功的时候MES会生成一个Ticket，此Ticket在非匿名方法的时候必须作为参数传入MES。备注每个Ticket有效期默认为30分钟。03Api接口的开发和测试Api接口的开发Api接口的开发Api方法：在控制器公开的方法上标记Api特性，则称之为Api方法，标记了Api特性的方法，为Api接口，外部系统可以调用；Api特性包括：

ApiService：Api开放接口标记，方法标记了ApiService外部系统就可以调用到该方法；

ApiReturn：Api开放接口返回值；

ApiParameter：Api开放接口参数说明；Api方法必须写到服务端工程的控制器中。思考题Api接口的方法可以是私有方法么？Api接口的方法能否在UI端工程实现？Api接口的开发示例需求描述获取员工维护的信息，根据查询关键字、页数和页数据数量进行员工维护数据的查询；查询条件说明：当查询关键字为空时，查所有数据，不为空时，查询关键字去匹配员工编码和姓名；当页数为空时，查询第一页的数据，不为空则根据实际输入的页数进行查询；当页数据数量为空时，查询所有数据，不为空则根据实体输入的页数据数量进行查询；返回值：查询完成后，返回页数、页数据数量、数据总数和基本数据信息列表，基本数据信息列表包括员工ID、编码和名称。Api接口的开发示例开发步骤Api接口返回值类的定义，如果与第三方系统对接，返回值类的属性要与第三方系统接口对接的人员对接好，根据他们的要求定义。Api接口的开发示例开发步骤接口方法的实现；Api接口的开发示例开发步骤查看api，以本地调试为例，在SIE.WebApiHost中将写api方法的工程引用进来；Api接口的开发示例开发步骤将配置文件配置好，启用SIE.WebApiHost；Api接口的开发示例开发步骤启动成功后，在浏览器输入：http://localhost:5102/api/dataportal，其中localhost:5102为启动服务的IP和端口。Api接口的开发示例开发步骤启动成功后，在浏览器输入：http://localhost:5102/api/dataportal，其中localhost:5102为启动服务的IP和端口；Api接口的开发示例开发步骤将ApiRequest的内容拷贝到“Api使用说明”的“请求”中，如下；Api接口的开发示例开发步骤输入用户名和密码获取票据，更改参数，如下；Api接口的开发示例开发步骤点击POST请求，查看返回值，可以进行接口的测试是否存在问题；Api接口的开发示例开发步骤如果接口有问题，在点击post之前，对接口方法设置断点进行调试；Api接口的开发示例开发步骤Api方法写完之后，为了方便跟其他系统对接或者是方便后期的运维，需要写对应api方法的接口卡，接口卡格式示例如下；04Api接口的调用接口的调用接口的调用C#调用api接口。接口的调用接口的调用PDA使用vue调度Api练习1、Api接口的特性包括？（）2、Api接口方法可以不是虚方法。（）3、工业管理软件开发的WebApi接口只支持Post方式请求。（）。ApiService、ApiPa