《《API文檔模板》word版.doc》由會(huì)員分享,可在線閱讀,更多相關(guān)《《API文檔模板》word版.doc(4頁(yè)珍藏版)》請(qǐng)?jiān)谘b配圖網(wǎng)上搜索。
1、項(xiàng)目推薦接口文檔1. 目錄項(xiàng)目推薦接口文檔11. 目錄12. 版本信息13. 接口說(shuō)明14. 獲取項(xiàng)目推薦列表16.項(xiàng)目詳情37. 實(shí)體參數(shù)38. ProjectsModel 實(shí)體39. CategoryModel410. IndustryModel423.ProjectsModel411. 枚舉說(shuō)明412. 聯(lián)系方式42. 版本信息版本號(hào)時(shí)間編寫(xiě)人員說(shuō)明V1.0.0.02015/4/25劉志明起稿3. 接口說(shuō)明4. 獲取項(xiàng)目推薦列表5. Api地址:環(huán)境Api地址測(cè)試環(huán)境真實(shí)環(huán)境6. 參數(shù)定義:參數(shù)名稱參數(shù)類型可空說(shuō)明nodecodeStringN會(huì)員賬號(hào)cidIntY所屬類別idpages
2、izeIntN每頁(yè)顯示的數(shù)據(jù)條數(shù)(默認(rèn)為8)pageindexIntN當(dāng)前頁(yè)數(shù)(默認(rèn)為1)SignStringN數(shù)據(jù)簽名,簽名順序按此表格參數(shù)順序。函數(shù)返回ResultBoolN 處理成功失敗MessageStringY如果處理失敗則為失敗原因,成功則為無(wú)。DataListY項(xiàng)目推薦列表集合請(qǐng)參考ProjectsModel 實(shí)體5.獲取自己的推薦項(xiàng)目列表1. Api地址:環(huán)境Api地址測(cè)試環(huán)境真實(shí)環(huán)境2. 參數(shù)定義:參數(shù)名稱參數(shù)類型可空說(shuō)明nodecodeStringN會(huì)員賬號(hào)StatusIntY狀態(tài)(0=未審核 1=審核成功 2=審核失敗)pagesizeIntN每頁(yè)顯示的數(shù)據(jù)條數(shù)(默認(rèn)為8
3、)pageindexIntN當(dāng)前頁(yè)數(shù)(默認(rèn)為1)SignStringN數(shù)據(jù)簽名,簽名順序按此表格參數(shù)順序。函數(shù)返回ResultBoolN 處理成功失敗MessageStringY如果處理失敗則為失敗原因,成功則為無(wú)。DataListY項(xiàng)目推薦列表集合請(qǐng)參考ProjectsModel 實(shí)體6.項(xiàng)目詳情3. Api地址環(huán)境Api地址測(cè)試環(huán)境真實(shí)環(huán)境2.參數(shù)定義參數(shù)名稱參數(shù)類型可空說(shuō)明ProjectIdIntN項(xiàng)目idSignStringN數(shù)據(jù)簽名,簽名順序按此表格參數(shù)順序。函數(shù)返回ResultBoolN 處理成功失敗MessageStringY如果處理失敗則為失敗原因,成功則為無(wú)。DataProjectsModelY項(xiàng)目推薦列表集合請(qǐng)參考7. 實(shí)體參數(shù)8. ProjectsModel 實(shí)體參數(shù)名稱參數(shù)類型是否為空N/Y說(shuō)明9. CategoryModel參數(shù)名稱參數(shù)類型是否為空說(shuō)明10. IndustryModel 參數(shù)名稱參數(shù)類型是否為空說(shuō)明23.ProjectsModel參數(shù)名稱參數(shù)類型是否為空說(shuō)明11. 枚舉說(shuō)明值說(shuō)明0說(shuō)明1說(shuō)明2說(shuō)明12. 聯(lián)系方式姓名工作QQ手機(jī)號(hào)碼工作郵箱 4 / 4