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