api接口文檔免費(fèi)模板（api接口文檔生成工具）
本篇文章給大家談?wù)刟pi接口文檔免費(fèi)模板，以及api接口文檔生成工具對應(yīng)的知識點(diǎn)，希望對各位有所幫助，不要忘了收藏本站喔。
本文目錄一覽：
想問一下什么是API接口，具體是什么意思
API接口：
API（Application Programming Interface,應(yīng)用程序編程接口）是一些預(yù)先定義的函數(shù)，目的是提供應(yīng)用程序與開發(fā)人員基于某軟件或硬件得以訪問一組例程的能力，而又無需訪問源碼，或理解內(nèi)部工作機(jī)制的細(xì)節(jié)。
API函數(shù)包含在Windows系統(tǒng)目錄下的動態(tài)連接庫文件中。Windows API是一套用來控制Windows的各個部件的外觀和行為的預(yù)先定義的Windows函數(shù)。
在linux中，用戶編程接口API遵循了UNIX中最流行的應(yīng)用編程界面標(biāo)準(zhǔn)---POSIX標(biāo)準(zhǔn)。POSIX標(biāo)準(zhǔn)是由IEEE和ISO/IEC共同開發(fā)的標(biāo)準(zhǔn)系統(tǒng)。
擴(kuò)展資料：
API的程序功能：
遠(yuǎn)程過程調(diào)用（RPC）：通過作用在共享數(shù)據(jù)緩存器上的過程（或任務(wù)）實(shí)現(xiàn)程序間的通信。
標(biāo)準(zhǔn)查詢語言（SQL）：是標(biāo)準(zhǔn)的訪問數(shù)據(jù)的查詢語言，通過通用數(shù)據(jù)庫實(shí)現(xiàn)應(yīng)用程序間的數(shù)據(jù)共享。
文件傳輸：文件傳輸通過發(fā)送格式化文件實(shí)現(xiàn)應(yīng)用程序間數(shù)據(jù)共享。
信息交付：指松耦合或緊耦合應(yīng)用程序間的小型格式化信息，通過程序間的直接通信實(shí)現(xiàn)數(shù)據(jù)共享。
當(dāng)前應(yīng)用于 API 的標(biāo)準(zhǔn)包括ANSI 標(biāo)準(zhǔn)SQL API。另外還有一些應(yīng)用于其它類型的標(biāo)準(zhǔn)尚在制定之中。API 可以應(yīng)用于所有計(jì)算機(jī)平臺和操作系統(tǒng)。
參考資料來源：百度百科-api （應(yīng)用程序編程接口）
Baidu云盤API接口的使用使用說明
這幾天很有興致的學(xué)習(xí)了百度云盤文件API接口的使用 初步是想做一個在線android應(yīng)用 應(yīng)用中的文檔是存放在百度云盤的 主要是分一下幾個步驟 ??? 注冊百度賬號??? 登錄百度開發(fā)者中心??? 創(chuàng)建移動應(yīng)用 獲取對應(yīng)的（API Key Secret Key）??? 開通pcs API權(quán)限??? 獲取ACCESS_token（認(rèn)證編碼）??? 開發(fā)應(yīng)用 注意 ??? 開通移動應(yīng)用 獲取key??? 獲取token的時候我使用的安卓獲取的方式??? 通過我寫對應(yīng)api的例子我發(fā)現(xiàn) 其實(shí)就兩種情況 一種是get方式提交數(shù)據(jù) 另外一種是post方式提交數(shù)據(jù)??? get方式提交數(shù)據(jù) 我們用獲取云盤的信息為例 ??? 獲取云盤信息前我們要知道 我們要準(zhǔn)備好什么數(shù)據(jù) 請求參數(shù) ??? url: 標(biāo)明我們要訪問的網(wǎng)址路徑 值固定問 ??? method:標(biāo)明我們是請求云盤信息 值固定為 info ??? acceess_token:準(zhǔn)入標(biāo)識 值是我們自己申請的 接收返回參數(shù) ??? quota:云盤總?cè)萘??? used:云盤使用容量??? request_id:該請求的表示 沒啥用??? 返回的一個json串如下格式 { quota : used : request_id : }??? 我在做的時候你使用Gson工具將json串轉(zhuǎn)換到對應(yīng)的entity類中了 代碼如下 ??? [] /**??? * @param URLConnection conn通過get方式獲取StringBuffer??? * @return??? */??? private StringBuffer getJsonString（URLConnection conn） {??? InputStreamReader isr = null;??? BufferedReader br = null;??? StringBuffer *** = null;??? try {??? isr = new InputStreamReader（conn getInputStream（） gb ） ??? br = new BufferedReader（isr） ??? String line = null;??? *** = new StringBuffer（） ??? while （（line = br readLine（）） != null） {??? *** append（line） ??? *** append（ \r\n ） ??? }??? } catch （UnsupportedEncodingException e） {??? e printStackTrace（） ??? } catch （IOException e） {??? e printStackTrace（） ??? }finally{??? try {??? if（isr!=null）??? isr close（） ??? } catch （IOException e） {??? System out println（ 流關(guān)閉是異常 ） ??? e printStackTrace（） ??? }??? }??? return *** ;??? }??? /**??? * @return??? * @throws Exception??? * 獲取云空間的信息??? */??? public CloudInfo getCloudInfo（） throws Exception {??? URL u = new URL（ ?method=infoaccess_token=你申請的token的值 ;??? URLConnection conn = u openConnection（） // 打開網(wǎng)頁鏈接??? // 獲取用戶云盤信息??? String cloudJson = this getJsonString（conn） toString（）
// 解析成對象 下面有這個實(shí)體對象的類??? Gson gson = new Gson（） ??? CloudInfo cloudInfo = gson fromJson（cloudJson CloudInfo class） ??? System out println（ 云盤信息 +cloudInfo） ??? return cloudInfo;??? }??? /**??? * @param URLConnection conn通過get方式獲取StringBuffer??? * @return??? */??? private StringBuffer getJsonString（URLConnection conn） {??? InputStreamReader isr = null;??? BufferedReader br = null;??? StringBuffer *** = null;??? try {??? isr = new InputStreamReader（conn getInputStream（） gb ） ??? br = new BufferedReader（isr） ??? String line = null;??? *** = new StringBuffer（） ??? while （（line = br readLine（）） != null） {??? *** append（line） ??? *** append（ \r\n ） ??? }??? } catch （UnsupportedEncodingException e） {??? e printStackTrace（） ??? } catch （IOException e） {??? e printStackTrace（） ??? }finally{??? try {??? if（isr!=null）??? isr close（） ??? } catch （IOException e） {??? System out println（ 流關(guān)閉是異常 ） ??? e printStackTrace（） ??? }??? }??? return *** ;??? }??? /**??? * @return??? * @throws Exception??? * 獲取云空間的信息??? */??? public CloudInfo getCloudInfo（） throws Exception {??? URL u = new URL（ ?method=infoaccess_token=你申請的token的值 ;??? URLConnection conn = u openConnection（） // 打開網(wǎng)頁鏈接??? // 獲取用戶云盤信息??? String cloudJson = this getJsonString（conn） toString（） ??? // 解析成對象 下面有這個實(shí)體對象的類??? Gson gson = new Gson（） ??? CloudInfo cloudInfo = gson fromJson（cloudJson CloudInfo class） ??? System out println（ 云盤信息 +cloudInfo） ??? return cloudInfo;??? }??? [] package entity;??? import java lang reflect Type;??? /**??? * @author ydcun 獲取云空間的信息 例如 ??? * { quota : 空間配額 單位為字節(jié)??? * used : 已使用空間大小 單位為字節(jié) ??? * request_id : }??? */??? public class CloudInfo{??? private Double quota;??? private Double used;??? private Double request_id;??? /**??? * @return the quota 空間配額 單位為字節(jié)??? */??? public Double getQuota（） {??? return quota;??? }??? /**??? * @param quota the quota to set 空間配額 單位為字節(jié)??? */??? public void setQuota（Double quota） {??? this quota = quota;??? }??? /**??? * @return the used 已使用空間大小 單位為字節(jié)??? */??? public Double getused（） {??? return used;??? }??? /**??? * @param used the used to set 已使用空間大小 單位為字節(jié)??? */??? public void setused（Double used） {??? this used = used;??? }??? /**??? * @return the request_id??? */??? public Double getRequest_id（） {??? return request_id;??? }??? /**??? * @param request_id the request_id to set??? */??? public void setRequest_id（Double request_id） {??? this request_id = request_id;??? }??? @Override??? public String toString（） {??? return new StringBuffer（） append（ 空間容量 ） append（this getQuota（）/ / ） append（ M; 已用 ） append（this getused（）/ / ） append（ M; ） toString（） ??? }??? }??? package entity;??? import java lang reflect Type;??? /**??? * @author ydcun 獲取云空間的信息 例如 ??? * { quota : 空間配額 單位為字節(jié)??? * used : 已使用空間大小 單位為字節(jié) ??? * request_id : }??? */??? public class CloudInfo{??? private Double quota;??? private Double used;??? private Double request_id;??? /**??? * @return the quota 空間配額 單位為字節(jié)??? */??? public Double getQuota（） {??? return quota;??? }??? /**??? * @param quota the quota to set 空間配額 單位為字節(jié)??? */??? public void setQuota（Double quota） {??? this quota = quota;??? }??? /**??? * @return the used 已使用空間大小 單位為字節(jié)??? */??? public Double getused（） {??? return used;??? }??? /**??? * @param used the used to set 已使用空間大小 單位為字節(jié)??? */??? public void setused（Double used） {??? this used = used;??? }??? /**??? * @return the request_id??? */??? public Double getRequest_id（） {??? return request_id;??? }??? /**??? * @param request_id the request_id to set??? */??? public void setRequest_id（Double request_id） {??? this request_id = request_id;??? }??? @Override??? public String toString（） {??? return new StringBuffer（） append（ 空間容量 ） append（this getQuota（）/ / ） append（ M; 已用 ） append（this getused（）/ / ） append（ M; ） toString（） ??? }??? }
lishixinzhi/Article/program/Java/hx/201311/27162
什么是接口文檔？
接口文檔又稱為API文檔，一般是由開發(fā)人員所編寫的，用來描述系統(tǒng)所提供接口信息的文檔。 大家都根據(jù)這個接口文檔進(jìn)行開發(fā)，并需要一直維護(hù)和遵守。
如果想系統(tǒng)的學(xué)習(xí)接口測試相關(guān)的技術(shù)，可以了解一下黑馬程序員的軟件測試課程，里面講的非常詳細(xì)。
關(guān)于api接口文檔免費(fèi)模板和api接口文檔生成工具的介紹到此就結(jié)束了，不知道你從中找到你需要的信息了嗎 ？如果你還想了解更多這方面的信息，記得收藏關(guān)注本站。
掃描二維碼推送至手機(jī)訪問。
版權(quán)聲明：本文由飛速云SEO網(wǎng)絡(luò)優(yōu)化推廣發(fā)布，如需轉(zhuǎn)載請注明出處。
