3.11Api接口的開發(fā)實(shí)現(xiàn)深圳市信息職業(yè)技術(shù)學(xué)院目

錄接口介紹01Api接口的定義02Api接口的開發(fā)和測(cè)試03Api接口的調(diào)用04知識(shí)回顧行為的使用場(chǎng)景；行為的腳本模板；行為的開發(fā)步驟；行為的開發(fā)示例。學(xué)習(xí)目標(biāo)通過本節(jié)學(xué)習(xí)可以：掌握Api接口的定義；掌握Api接口的開發(fā)與調(diào)試；掌握接口卡的編寫；了解接口的介紹；了解Api接口的調(diào)用；01接口介紹接口介紹接口介紹WebApi是基于HTTP協(xié)議，無(wú)狀態(tài)的網(wǎng)絡(luò)應(yīng)用程序接口。數(shù)據(jù)格式為純文本，也可以被WebAPI的MediaTypeFormatter換成Json、XML或者任何你想轉(zhuǎn)換的格式，常用Json格式。是一個(gè)輕量級(jí)框架，非常適合移動(dòng)端客戶端服務(wù)。常用方式：①Get②Post③Put④DeleteWebServer是基于Soap協(xié)議，有狀態(tài)的網(wǎng)絡(luò)應(yīng)用程序接口。數(shù)據(jù)格式為XML。是一個(gè)平臺(tái)獨(dú)立的，松耦合的，自包含的、基于可編程的web的應(yīng)用程序，用于開發(fā)分布式的互操作的應(yīng)用程序。常用方式：①Http請(qǐng)求②RFC調(diào)用③服務(wù)引用④代理服務(wù)常用方式：①提供數(shù)據(jù)庫(kù)的連接地址并分配指定用戶權(quán)限②提供連接服務(wù)：Oracle的DBLink，Sqlserver的linkedserver接口介紹接口介紹所有的WebService都是WebAPI，但所有的WebAPI并不是WebService。兩者都是走HTTP協(xié)議的，SOAP協(xié)議也是基于HTTP協(xié)議的。但是WebServer的數(shù)據(jù)格式只能是XML，而WebApi是可以多種格式的，這就導(dǎo)致我們可以用WebApi的方式調(diào)用WebServer接口。WebService更加適合為端到端的場(chǎng)景提供服務(wù)，WebAPI則更加適合為應(yīng)用到應(yīng)用的場(chǎng)景提供服務(wù)。02Api接口的定義Api接口的定義Api接口的定義接口協(xié)議RestFulAPI方法名Login請(qǐng)求方式（Method）POST參數(shù)形式（ContentType）application/json描述第三方用戶調(diào)用此接口獲取數(shù)據(jù)參數(shù){"ApiType":

"AuthenticationController",

"Parameters":

[

{

"Value":

"str"

},

{

"Value":

"str"

}

],

"Method":

"Login",

"Context":

{}}Api接口的定義Api接口的定義接口協(xié)議RestFulAPI參數(shù)描述參數(shù)內(nèi)容需符合JSON格式，JSON串中的鍵僅允許26個(gè)小寫英文字母、阿拉伯?dāng)?shù)字和下劃線，且必須以小寫字母開頭，當(dāng)鍵由多個(gè)單詞組成時(shí)，單詞與單詞之間通過下劃線進(jìn)行連接，如未特別說明，本規(guī)范中定義的各字段的命名不能修改，最大封裝Json包100KB。ApiType：控制器名稱Parameters：參數(shù)Method：方法Context：內(nèi)容返回值成功：{

"Success":

true,

"Message":

null,

"Result":

0,

"Context":

{

"Ticket":

"XXX"

}

}失?。簕

"Success":

false,

"Message":

“錯(cuò)誤信息”,

"Result":

1,

"Context":

{

"Ticket":

""

}

}Api接口的定義Api接口的定義接口協(xié)議RestFulAPI返回值描述Json格式，Success是否成功：true成功，false失??；Message錯(cuò)誤信息；Result返回狀態(tài)，0成功，1失??；Context內(nèi)容：Ticket是憑證，在登錄成功的時(shí)候MES會(huì)生成一個(gè)Ticket，此Ticket在非匿名方法的時(shí)候必須作為參數(shù)傳入MES。備注每個(gè)Ticket有效期默認(rèn)為30分鐘。03Api接口的開發(fā)和測(cè)試Api接口的開發(fā)Api接口的開發(fā)Api方法：在控制器公開的方法上標(biāo)記Api特性，則稱之為Api方法，標(biāo)記了Api特性的方法，為Api接口，外部系統(tǒng)可以調(diào)用；Api特性包括：

ApiService：Api開放接口標(biāo)記，方法標(biāo)記了ApiService外部系統(tǒng)就可以調(diào)用到該方法；

ApiReturn：Api開放接口返回值；

ApiParameter：Api開放接口參數(shù)說明；Api方法必須寫到服務(wù)端工程的控制器中。思考題Api接口的方法可以是私有方法么？Api接口的方法能否在UI端工程實(shí)現(xiàn)？Api接口的開發(fā)示例需求描述獲取員工維護(hù)的信息，根據(jù)查詢關(guān)鍵字、頁(yè)數(shù)和頁(yè)數(shù)據(jù)數(shù)量進(jìn)行員工維護(hù)數(shù)據(jù)的查詢；查詢條件說明：當(dāng)查詢關(guān)鍵字為空時(shí)，查所有數(shù)據(jù)，不為空時(shí)，查詢關(guān)鍵字去匹配員工編碼和姓名；當(dāng)頁(yè)數(shù)為空時(shí)，查詢第一頁(yè)的數(shù)據(jù)，不為空則根據(jù)實(shí)際輸入的頁(yè)數(shù)進(jìn)行查詢；當(dāng)頁(yè)數(shù)據(jù)數(shù)量為空時(shí)，查詢所有數(shù)據(jù)，不為空則根據(jù)實(shí)體輸入的頁(yè)數(shù)據(jù)數(shù)量進(jìn)行查詢；返回值：查詢完成后，返回頁(yè)數(shù)、頁(yè)數(shù)據(jù)數(shù)量、數(shù)據(jù)總數(shù)和基本數(shù)據(jù)信息列表，基本數(shù)據(jù)信息列表包括員工ID、編碼和名稱。Api接口的開發(fā)示例開發(fā)步驟Api接口返回值類的定義，如果與第三方系統(tǒng)對(duì)接，返回值類的屬性要與第三方系統(tǒng)接口對(duì)接的人員對(duì)接好，根據(jù)他們的要求定義。Api接口的開發(fā)示例開發(fā)步驟接口方法的實(shí)現(xiàn)；Api接口的開發(fā)示例開發(fā)步驟查看api，以本地調(diào)試為例，在SIE.WebApiHost中將寫api方法的工程引用進(jìn)來(lái)；Api接口的開發(fā)示例開發(fā)步驟將配置文件配置好，啟用SIE.WebApiHost；Api接口的開發(fā)示例開發(fā)步驟啟動(dòng)成功后，在瀏覽器輸入：http://localhost:5102/api/dataportal，其中l(wèi)ocalhost:5102為啟動(dòng)服務(wù)的IP和端口。Api接口的開發(fā)示例開發(fā)步驟啟動(dòng)成功后，在瀏覽器輸入：http://localhost:5102/api/dataportal，其中l(wèi)ocalhost:5102為啟動(dòng)服務(wù)的IP和端口；Api接口的開發(fā)示例開發(fā)步驟將ApiRequest的內(nèi)容拷貝到“Api使用說明”的“請(qǐng)求”中，如下；Api接口的開發(fā)示例開發(fā)步驟輸入用戶名和密碼獲取票據(jù)，更改參數(shù)，如下；Api接口的開發(fā)示例開發(fā)步驟點(diǎn)擊POST請(qǐng)求，查看返回值，可以進(jìn)行接口的測(cè)試是否存在問題；Api接口的開發(fā)示例開發(fā)步驟如果接口有問題，在點(diǎn)擊post之前，對(duì)接口方法設(shè)置斷點(diǎn)進(jìn)行調(diào)試；Api接口的開發(fā)示例開發(fā)步驟Api方法寫完之后，為了方便跟其他系統(tǒng)對(duì)接或者是方便后期的運(yùn)維，需要寫對(duì)應(yīng)api方法的接口卡，接口卡格式示例如下；04Api接口的調(diào)用接口的調(diào)用接口的調(diào)用C#調(diào)用api接口。接口的調(diào)用接口的調(diào)用PDA使用vue調(diào)度Api練習(xí)1、Api接口的特性包括？（）2、Api接口方法可以不是虛方法。（）3、工業(yè)管理軟件開發(fā)的WebApi接口只支持Post方式請(qǐng)求。（）。ApiService、ApiPa