2023學(xué)年完整公開課版API接口設(shè)計(jì)

API接口設(shè)計(jì)1、了解API接口設(shè)計(jì)

API接口設(shè)計(jì)

項(xiàng)目使用統(tǒng)一的API與數(shù)據(jù)庫進(jìn)行交互，所有的API定義在dataserivce/data.py文件中。API接口設(shè)計(jì)各個(gè)API的接口說明：get_all_tag:API接口設(shè)計(jì)功能獲取所有標(biāo)簽信息參數(shù)無返回值標(biāo)簽數(shù)據(jù)Dictionary（python），KeyValue格式為<標(biāo)簽ID，標(biāo)簽名>get_analysis_data_group_by_tag:API接口設(shè)計(jì)功能以標(biāo)簽為分組條件，獲取標(biāo)簽對(duì)應(yīng)的職位數(shù)量。支持通過參數(shù)指定返回標(biāo)簽個(gè)數(shù)。參數(shù)topK（缺省時(shí)為10），數(shù)字，指定獲取職位最多的前幾個(gè)數(shù)據(jù)。返回值1[標(biāo)簽名，標(biāo)簽名，標(biāo)簽名…]返回值2[數(shù)量1，數(shù)量2，數(shù)量3…]說明兩個(gè)返回值的按照先后順序具有一一對(duì)應(yīng)關(guān)系get_scatter_data_group_by_tag:API接口設(shè)計(jì)功能以標(biāo)簽為分組條件，獲取標(biāo)簽對(duì)應(yīng)的職位分布。支持通過參數(shù)指定返回標(biāo)簽個(gè)數(shù)。參數(shù)無返回值[{name:標(biāo)簽名1,value:職位數(shù)量},{name:標(biāo)簽名1,value:職位數(shù)量}，…]get_scatter_data_group_by_position:API接口設(shè)計(jì)功能以傳入的標(biāo)簽數(shù)據(jù)作為過濾條件對(duì)數(shù)據(jù)進(jìn)行篩選后，以崗位為單位統(tǒng)計(jì)職位分布。參數(shù)無返回值[{name:崗位名1,value:職位數(shù)量},{name:崗位名2,value:職位數(shù)量}，…]get_analysis_data_group_by_month:API接口設(shè)計(jì)功能根據(jù)參數(shù)傳入的過濾條件對(duì)數(shù)據(jù)進(jìn)行篩選后，以月份為單位統(tǒng)計(jì)職位數(shù)量參數(shù)1tag_id（缺省為None），標(biāo)簽id，指定標(biāo)簽過濾條件。缺省時(shí)不按照標(biāo)簽進(jìn)行數(shù)據(jù)過濾。參數(shù)2position（缺省為None），崗位名稱，指定崗位過濾條件。缺省時(shí)不按照崗位進(jìn)行數(shù)據(jù)過濾。返回值[[“月份1”,數(shù)量1],[“月份2”,數(shù)量2],[“月份3”,數(shù)量3],…]說明1.若參數(shù)tag_id缺省，則直接無視參數(shù)position的傳入內(nèi)容；2.若當(dāng)前只有一個(gè)月的數(shù)據(jù)，下一個(gè)月的字符串結(jié)尾加字符“E”后在圖標(biāo)顯示，但沒有數(shù)值。get_analysis_data_group_by_Location:API接口設(shè)計(jì)功能根據(jù)參數(shù)傳入的過濾條件對(duì)數(shù)據(jù)進(jìn)行篩選后，以城市為單位統(tǒng)計(jì)職位數(shù)量參數(shù)1tag_id（缺省為None），標(biāo)簽id，指定標(biāo)簽過濾條件。缺省時(shí)不按照標(biāo)簽進(jìn)行數(shù)據(jù)過濾。參數(shù)2position（缺省為None），崗位名稱，指定崗位過濾條件。缺省時(shí)不按照崗位進(jìn)行數(shù)據(jù)過濾。返回值[{name:’城市1’,value:數(shù)量1},{name:’城市2’,value:數(shù)量2},{name:’城市3’,value:數(shù)量3}]說明若參數(shù)tag_id缺省，則直接無視參數(shù)position的傳入內(nèi)容；get_word_analysis_data:API接口設(shè)計(jì)功能獲取特定標(biāo)簽、特定崗位的關(guān)鍵詞云參數(shù)1tag_id，標(biāo)簽id，指定標(biāo)簽過濾條件。參數(shù)2position，崗位名稱，指定崗位過濾條件。返回值{“詞1”:數(shù)量1,”詞2”:數(shù)量2,”詞3”:數(shù)量3}synchronize:API接口設(shè)計(jì)功能提供外部系統(tǒng)調(diào)用，將暫存表的數(shù)據(jù)同步到正式