




版權說明:本文檔由用戶提供并上傳,收益歸屬內容提供方,若內容存在侵權,請進行舉報或認領
文檔簡介
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
溫馨提示
- 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯系上傳者。文件的所有權益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網頁內容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
- 4. 未經權益所有人同意不得將文件中的內容挪作商業或盈利用途。
- 5. 人人文庫網僅提供信息存儲空間,僅對用戶上傳內容的表現方式做保護處理,對用戶上傳分享的文檔內容本身不做任何修改或編輯,并不能對任何下載內容負責。
- 6. 下載文件中如有侵權或不適當內容,請與我們聯系,我們立即糾正。
- 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。
最新文檔
- 水穩站股份合同協議書
- 簡短愛情協議書
- 地鐵kpi績效協議書
- 聚餐經費協議書
- 繼續婚姻協議書
- 殯儀館公建民營協議書
- 肉毒注射協議書
- 道和生發協議書
- 聘用店長協議書
- 貸款配資協議書
- 醫院感染預防與控制的基本概念和原則
- 2024年數字廣西集團有限公司招聘筆試參考題庫含答案解析
- 食堂鋼絲球管理制度
- 住宅室內裝飾裝修工程施工合同
- 巖土工程中英文對照外文翻譯文獻
- 河南省職業技能等級認定試卷-證書-網絡與信息安全管理員三級實操樣卷評分記錄表
- 2023年1月浙江省高考英語真題聽力試題(附聽力音頻+答案+文本)
- ansys課程設計論文2
- 2022年學前教育生均公用經費項目績效評價報告
- 第七講-氣流干燥系統設計特點
- 錨桿(土釘)鉆孔施工記錄
評論
0/150
提交評論