開發(fā)接口 API 模板

1、XXX項目接口文檔 版本控制信息 版本 日期 描述 作者 2018-8-13 創(chuàng)建XXX 1 獲取所有字段 1.1 獲取所有字段 請求地址：/session/field/findAll 請求參數(shù) 參數(shù)名 必填 字段類型 描述 name 是 String 根據(jù)名稱篩選 響應(yīng) 必填參數(shù)為空10001系統(tǒng)錯誤，-1成功，10000 code 響應(yīng)描述message 如響應(yīng)例子result 成功，系統(tǒng)處理正常！請求例子：響應(yīng)例子：屻潣敤?敜捸灥楴湯?畮汬尬獩畓搗獥屳琺畬?浜獥慳敧?,page:0,pageSize:0,eturnObject:null,eturnValue:ypes:null,vill

2、ages:null,companys:iconColour:,conColour:,iconSize:0,iconStyle:,id:7,ame:XX,otals:0 2 文件上傳 2.1 文件上傳（ajax） 請求地址：/session/file/upload 請求參數(shù) 參數(shù)名 必填 字段類型 描述 file 是 FormData FormData對象包含的文件 響應(yīng) 10000成功，-1系統(tǒng)錯誤，10001必填參數(shù)為空 codemessage 響應(yīng)描述 result 如響應(yīng)例子 請求例子：var formData = new FormData(); (ile, 0); $.ajax( ur

3、l : routePath + /session/file/upload, type : POST, data : formData, processData : false, contentType : false, success : function(result) result = (result); if = 00) ( 上傳成功！); $(#editHeadPortrait).val ); 響應(yīng)例子：returnValue里包含了 fileName和filePath 3 字段管理-所屬類型 3.1 新增所屬類型 請求地址：/session/fieldType/save 請求參數(shù) 參

4、數(shù)名 必填 字段類型 描述 name 是String 所屬類型名稱 響應(yīng)code 10000成功，-1系統(tǒng)錯誤，10001必填參數(shù)為空 message 響應(yīng)描述 result 如響應(yīng)例子 請求例子：響應(yīng)例子：屻潣敤?敜捸灥楴湯?畮汬尬獩畓搗獥屳琺畬?浜獥慳敧?成功，系統(tǒng)處理正常！,page:0,pageSize:0,eturnListSize:0,eturnObject:null,eturnValue:null,otals:0 3.2 修改所屬類型 請求地址：/session/fieldType/update 請求參數(shù) 參數(shù)名 必填 字段類型 描述 id 是 Long 所屬類型id name

5、是 String 所屬類型名稱 響應(yīng) 10000成功，-1 code系統(tǒng)錯誤，10001必填參數(shù)為空 message 響應(yīng)描述 result 如響應(yīng)例子 請求例子：&name=test 響應(yīng)例子：屻潣敤?敜捸灥楴湯?畮汬尬獩畓搗獥屳琺畬?浜獥慳敧?成功，系統(tǒng)處理正常！,page:0,pageSize:0,eturnListSize:0,eturnObject:null,eturnValue:null,otals:0 3.3 根據(jù)id獲取所屬類型 /session/fieldType/getById 請求地址：請求參數(shù) 參數(shù)名 必填 字段類型 描述 id 是 Long 所屬類型id 響應(yīng) 100

6、00成功，-1code 系統(tǒng)錯誤，10001必填參數(shù)為空 message 響應(yīng)描述 result 如響應(yīng)例子 請求例子：響應(yīng)例子：屻潣敤?敜捸灥楴湯?畮汬尬獩畓搗獥屳琺畬?浜獥慳敧?成功，系統(tǒng)處理正常！,page:0,pageSize:0,eturnListSize:0,eturnObject:null,eturnValue:id:2,ame:e,otals:0 3.4 獲取所屬類型列表 請求地址：/session/fieldType/selectAll 請求參數(shù) 參數(shù)名 必填 字段類型 描述 name 否 String 根據(jù)類型名稱篩選 響應(yīng) 10000成功，-1系統(tǒng)錯誤，10001必填參數(shù)為空code message 響應(yīng)描述 如響應(yīng)例子 result成功，系統(tǒng)處理正常！屻潣敤?敜捸灥楴湯?畮汬尬獩畓搗獥屳琺畬?浜獥慳敧?請求例子：響應(yīng)例子：d:6,ame:e555,otals:2 3.5 刪除所屬類型（批量） 請求地址：/session/fieldType/deleteByIds 請求參數(shù) 參數(shù)名 必填 字段類型 描述 ids 是 List 所屬類型id集合 響應(yīng) code 10000成功，-1系統(tǒng)錯誤，10001必填參數(shù)為空 message 響應(yīng)描述 result 如響應(yīng)例子 請求例子：響應(yīng)例子：屻潣敤