接口需求文檔

接口:兩個(gè)獨(dú)立系統(tǒng)之間同步數(shù)據(jù)或訪問對方程序的途徑

一吃靠、如何設(shè)計(jì)接口

1. 搞清楚是主動訪問還是被動請求

1.1. 主動訪問:一是我方是數(shù)據(jù)的使用方状答,需要主動從對方獲取數(shù)據(jù)辅鲸;二是我方是數(shù)據(jù)的提供方菩彬,需要主動將數(shù)據(jù)同步給對方赁还。

主動訪問無需做接口,是訪問對方的接口漏麦。需要明確需要在什么節(jié)點(diǎn)訪問對方的接口客税?用戶觸發(fā)什么操作實(shí)時(shí)去訪問?還是沒有實(shí)時(shí)要求唁奢,而是周期性地訪問霎挟?

Senario 1 我方數(shù)據(jù)使用方,需要的數(shù)據(jù)是用戶使用某個(gè)功能必須的數(shù)據(jù)麻掸。在操作時(shí)酥夭,實(shí)時(shí)訪問對方的接口獲取數(shù)據(jù)展示給用戶,如注冊某網(wǎng)站時(shí)獲取驗(yàn)證碼的功能脊奋。

Senario 2 我方數(shù)據(jù)使用方熬北,且需要的數(shù)據(jù)跟用戶實(shí)時(shí)操作無關(guān)的基礎(chǔ)數(shù)據(jù)。一般處理:腳本定時(shí)(如:兩個(gè)小時(shí)一次)訪問對方接口將數(shù)據(jù)獲取來存儲到自己的數(shù)據(jù)庫诚隙,再用刀的時(shí)候直接從數(shù)據(jù)庫去獲取并展示讶隐。

Senario 3. 我方數(shù)據(jù)提供方并且數(shù)據(jù)是下游系統(tǒng)需要的實(shí)時(shí)呀求高的數(shù)據(jù)則更多地用實(shí)時(shí)同步;若是基礎(chǔ)數(shù)據(jù)久又,則選擇周期性同步的方式巫延。

1.2. 被動請求:

一是我方是數(shù)據(jù)提供方,需要對方來獲取數(shù)據(jù)地消;二是我方是數(shù)據(jù)使用方炉峰,需要對方主動將數(shù)據(jù)同步過來。

被動請求需要提供接口供對方訪問脉执。確定的點(diǎn):1. 對方訪問時(shí)疼阔,需要提供什么樣的參數(shù)?根據(jù)提供的參數(shù)需要返回什么數(shù)據(jù)半夷?數(shù)據(jù)從什么地方取值婆廊?

Senario 1 我方數(shù)據(jù)使用方,不知道上有系統(tǒng)什么節(jié)點(diǎn)產(chǎn)生了數(shù)據(jù)及數(shù)據(jù)產(chǎn)生的時(shí)間巫橄,無法及時(shí)去獲取淘邻,可讓對方主動將數(shù)據(jù)同步過來。

二湘换、搞清楚數(shù)據(jù)交互的實(shí)時(shí)性要求

Senario 1 我方數(shù)據(jù)使用方列荔,需要根據(jù)業(yè)務(wù)的需要決定獲取數(shù)據(jù)的實(shí)時(shí)性敬尺。實(shí)時(shí)?周期性贴浙?

三、選擇合適的接口方式

1. mq消息隊(duì)列:一個(gè)中間件署恍,數(shù)據(jù)提供方將數(shù)據(jù)放到數(shù)據(jù)中間件崎溃,數(shù)據(jù)獲取放從中間件中獲取數(shù)據(jù)。針對向多個(gè)系統(tǒng)同步基礎(chǔ)數(shù)據(jù)的需要盯质,消息隊(duì)列是最適合的方式袁串。

若選擇這種同步方式,要注意的一點(diǎn)是:增量同步還是全量同步呼巷,若是增量同步囱修,對方是增量獲取還是全量獲取王悍?若是全量同步破镰,在什么情況下,對方應(yīng)該更新數(shù)據(jù)压储,什么情況下應(yīng)該更新數(shù)據(jù)鲜漩?

2. otter同步:數(shù)據(jù)同步方直接訪問數(shù)據(jù)獲取放的數(shù)據(jù)表將數(shù)據(jù)寫入對應(yīng)的表重。實(shí)時(shí)性最高集惋。

3. http: 常用孕似,雙方通過http地址保持?jǐn)?shù)據(jù)同步和通信。

四刮刑、如何編寫接口文檔

主動/被動+數(shù)據(jù)使用方/數(shù)據(jù)獲取方的維度

Senario 1 對方系統(tǒng)主動推送數(shù)據(jù):

Senario 2 對方主動來獲取數(shù)據(jù)獲取數(shù)據(jù)

Senario 3 被動接受對方推送的數(shù)據(jù)

Senario 4 主動從對方獲取數(shù)據(jù)

摘抄自:http://www.woshipm.com/pmd/2297401.html

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末喉祭,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子雷绢,更是在濱河造成了極大的恐慌泛烙,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,454評論 6 493
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件习寸,死亡現(xiàn)場離奇詭異胶惰,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)霞溪,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,553評論 3 385
  • 文/潘曉璐 我一進(jìn)店門孵滞,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人鸯匹,你說我怎么就攤上這事坊饶。” “怎么了殴蓬?”我有些...
    開封第一講書人閱讀 157,921評論 0 348
  • 文/不壞的土叔 我叫張陵匿级,是天一觀的道長蟋滴。 經(jīng)常有香客問我,道長痘绎,這世上最難降的妖魔是什么津函? 我笑而不...
    開封第一講書人閱讀 56,648評論 1 284
  • 正文 為了忘掉前任,我火速辦了婚禮孤页,結(jié)果婚禮上尔苦,老公的妹妹穿的比我還像新娘。我一直安慰自己行施,他們只是感情好允坚,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,770評論 6 386
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著蛾号,像睡著了一般稠项。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上鲜结,一...
    開封第一講書人閱讀 49,950評論 1 291
  • 那天展运,我揣著相機(jī)與錄音,去河邊找鬼轻腺。 笑死乐疆,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的贬养。 我是一名探鬼主播挤土,決...
    沈念sama閱讀 39,090評論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼误算!你這毒婦竟也來了仰美?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,817評論 0 268
  • 序言:老撾萬榮一對情侶失蹤儿礼,失蹤者是張志新(化名)和其女友劉穎咖杂,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體蚊夫,經(jīng)...
    沈念sama閱讀 44,275評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡诉字,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,592評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了知纷。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片壤圃。...
    茶點(diǎn)故事閱讀 38,724評論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖琅轧,靈堂內(nèi)的尸體忽然破棺而出伍绳,到底是詐尸還是另有隱情,我是刑警寧澤乍桂,帶...
    沈念sama閱讀 34,409評論 4 333
  • 正文 年R本政府宣布冲杀,位于F島的核電站效床,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏权谁。R本人自食惡果不足惜剩檀,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,052評論 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望旺芽。 院中可真熱鬧谨朝,春花似錦、人聲如沸甥绿。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,815評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽共缕。三九已至,卻和暖如春士复,著一層夾襖步出監(jiān)牢的瞬間图谷,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,043評論 1 266
  • 我被黑心中介騙來泰國打工阱洪, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留便贵,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,503評論 2 361
  • 正文 我出身青樓冗荸,卻偏偏與公主長得像承璃,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子蚌本,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,627評論 2 350

推薦閱讀更多精彩內(nèi)容

  • 在產(chǎn)品設(shè)計(jì)工作中程癌,或多或少都會需要用到接口舷嗡,特別是業(yè)務(wù)導(dǎo)向性的系統(tǒng),接口幾乎是必不可少的功能嵌莉。那么什么是接口进萄?如何...
    天邊那一抹閱讀 25,967評論 12 21
  • 1、客戶端與服務(wù)器端交互的網(wǎng)絡(luò)傳輸協(xié)議 https锐峭。 2中鼠、客戶端與服務(wù)器端交互的數(shù)據(jù)格式 json(utf-8編碼...
    心遠(yuǎn)久長閱讀 3,559評論 0 4
  • 1.注冊接口 1.接口地址:http://www.51qingyuan.com/register.php2.支持格...
    睡雨閱讀 32,651評論 5 51
  • Swift1> Swift和OC的區(qū)別1.1> Swift沒有地址/指針的概念1.2> 泛型1.3> 類型嚴(yán)謹(jǐn) 對...
    cosWriter閱讀 11,093評論 1 32
  • 國家電網(wǎng)公司企業(yè)標(biāo)準(zhǔn)(Q/GDW)- 面向?qū)ο蟮挠秒娦畔?shù)據(jù)交換協(xié)議 - 報(bào)批稿:20170802 前言: 排版 ...
    庭說閱讀 10,934評論 6 13