開發(fā)接口文檔-API文檔模板參考范本

精品文檔交流精品文檔交流XXX 項目接口文檔版本控制信息版本 日期 描述 作者V1.0 2018-8-13 創(chuàng)建 XXX獲取所有字段獲取所有字段請求地址：/session/field/findAll請求參數(shù)參數(shù)名必填字段類型描述name是String根據(jù)名稱篩選響應(yīng)code10000 -1系統(tǒng)錯誤，10001必填參數(shù)為空message響應(yīng)描述result如響應(yīng)例子請求例子：:8080/session/field/findAll?name=X響應(yīng)例子：{"code":"10000","exception":null,"isSuccess":true,"message":" 成功，系統(tǒng)處理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"","iconSize":0,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0}文件上傳文件上傳（ajax）請求地址：/session/file/upload請求參數(shù)參數(shù)名 必填 字段類型 描述file 是 FormData FormData 對象包含的文件響應(yīng)code 10000 -1系統(tǒng)錯誤，10001必填參數(shù)為空message 響應(yīng)描述result 如響應(yīng)例子請求例子：varformData=newFormData();formData.append("file",this.files[0]);$.ajax({url:routePath+"/session/file/upload",type:'POST',data:formData,processData:false,contentType:false,success:function(result){result=JSON.parse(result);if(result.code=="10000"){layer.msg(' 上傳成功！');$("#editHeadPortrait").val(result.returnValue.filePath);}}});響應(yīng)例子：returnValue 里包含了fileName 和filePath字段管理所屬類型新增所屬類型請求地址：/session/fieldType/save請求參數(shù)參數(shù)名 必填 字段類型 描述name 是 String 所屬類型名稱響應(yīng)code 10000 -1系統(tǒng)錯誤，10001必填參數(shù)為空message 響應(yīng)描述result 如響應(yīng)例子請求例子：:8080/session/fieldType/save?name=13243434響應(yīng)例子：{"code":"10000","exception":null,"isSuccess":true,"message":" 成功，系統(tǒng)處理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}修改所屬類型請求地址：/session/fieldType/update請求參數(shù)參數(shù)名 必填 字段類型 描述id 是 Long 所屬類型idname 是 String 所屬類型名稱響應(yīng)code 10000 -1系統(tǒng)錯誤，10001必填參數(shù)為空message 響應(yīng)描述result 如響應(yīng)例子請求例子：:8080/session/fieldType/update?id=2&name=test響應(yīng)例子：{"code":"10000","exception":null,"isSuccess":true,"message":" 成功，系統(tǒng)處理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}根據(jù)id獲取所屬類型請求地址：/session/fieldType/getById請求參數(shù)參數(shù)名 必填 字段類型 描述id 是 Long 所屬類型id響應(yīng)code 10000 -1系統(tǒng)錯誤，10001必填參數(shù)為空message 響應(yīng)描述result 如響應(yīng)例子請求例子：:8080/session/fieldType/getById?id=2響應(yīng)例子：{"code":"10000","exception":null,"isSuccess":true,"message":" 成功，系統(tǒng)處理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":{"id":2,"name":"re"},"totals":0}獲取所屬類型列表請求地址：/session/fieldType/selectAll請求參數(shù)參數(shù)名 必填 字段類型 描述name 否 String 根據(jù)類型名稱篩選響應(yīng)code 10000 -1系統(tǒng)錯誤，10001必填參數(shù)為空message 響應(yīng)描述result 如響應(yīng)例子請求例子：:8080/session/fieldType/selectAll?name=1響應(yīng)例子：{"code":"10000","exception":null,"isSuccess":true,"message":" 成功，系統(tǒng)處理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":[{"id":1,"name":"123"},{"id":6,"name":"145555"}],"totals":2}刪除所屬類型（批量）請求地址：/session/fieldType/deleteByIds請求參數(shù)參數(shù)名 必填 字段類型 描述ids 是 List 所屬類型id集合響應(yīng)code 10000 -1系統(tǒng)錯誤，10001必填參數(shù)為空message 響應(yīng)描述result 如響應(yīng)例子請求例子：:8080/session/fieldType/deleteByIds?ids=1響應(yīng)例子：{"code":"10000","exception":null,"isSuccess":true,"message":" 成功，系統(tǒng)處理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}精品文檔交流精品文檔交流1 總則1.1 為了加強公司的環(huán)境衛(wèi)生管理，創(chuàng)造一個整潔、文明、溫馨的購物、辦公環(huán)境，根據(jù)《公共場所衛(wèi)生管理條例》的要求，特制定本制度。1.2 集團公司的衛(wèi)生管理部門設(shè)在企管部，并負(fù)責(zé)將集團公司的衛(wèi)生區(qū)域詳細(xì)劃分到各部室，各分公司所轄區(qū)域衛(wèi)生由分公司客服部負(fù)責(zé)劃分，確保無遺漏。2 衛(wèi)生標(biāo)準(zhǔn)2.1 室內(nèi)衛(wèi)生標(biāo)準(zhǔn)2.1.1 地面、墻面：無灰塵、無紙屑、無痰跡、無泡泡糖等粘合物、無積水，墻角無灰吊、無蜘蛛網(wǎng)。2.1.2 門、窗、玻璃、鏡子、柱子、電梯、樓梯、燈具等，做到明亮、無灰塵、無污跡、無粘合物，特別是玻璃，要求兩面明亮。2.1.3 柜臺、貨架：清潔干凈，貨架、柜臺底層及周圍無亂堆亂放現(xiàn)象、無灰塵、無粘合物，貨架頂部、背部和底部干凈，不存放雜物和私人物品。2.1.4 購物車（筐）、直接接觸食品的售貨工具（包括刀、叉等）：做到內(nèi)外潔凈，無污垢和粘合物等。購物車（筐）要求每天營業(yè)前簡單清理，周五全面清理消毒；售貨工具要求每天消毒，并做好記錄。2.1.5 商品及包裝：商品及外包裝清潔無灰塵（外包裝破損的或破舊的不得陳列）。2.1.6 收款臺、服務(wù)臺、辦公櫥、存包柜：保持清潔、無灰塵，臺面和側(cè)面無灰塵、無灰吊和蜘蛛網(wǎng)。桌面上不得亂貼、亂畫、亂堆放物品，用具擺放有序且干凈，除當(dāng)班的購物小票收款聯(lián)外，其它單據(jù)不得存放在桌面上。2.1.7 垃圾桶：桶內(nèi)外干凈，要求營業(yè)時間隨時清理，不得溢出，每天下班前徹底清理，不得留有垃圾過夜。2.1.8 窗簾：定期進行清理，要求干凈、無污漬。2.1.9 吊飾：屋頂?shù)牡躏椧鬅o灰塵、無蜘蛛網(wǎng)，短期內(nèi)不適用的吊飾及時清理徹底。2.1.10 內(nèi)、外倉庫：半年徹底清理一次，無垃圾、無積塵、無蜘蛛網(wǎng)等。2.1.11 室內(nèi)其他附屬物及工作用具均以整潔為準(zhǔn)，要求無灰塵、無粘合物等污垢。2.2 室外衛(wèi)生標(biāo)準(zhǔn)2.2.1 門前衛(wèi)生：地面每天班前清理，平時每一小時清理一次，每周四營業(yè)結(jié)束后有條件的用水沖洗地面（冬季可根據(jù)情況適當(dāng)清理），墻面干凈且無亂貼亂畫。2.2.2 院落衛(wèi)生：院內(nèi)地面衛(wèi)生全天保潔，果皮箱、消防器械、護欄及配電箱等設(shè)施每周清理干凈。垃圾池周邊衛(wèi)生清理徹底，不得有垃圾溢出。2.2.3 綠化區(qū)衛(wèi)生：做到無雜物、無紙屑、無塑料袋等垃圾。3 清理程序3.1 室內(nèi)和門前院落等區(qū)域衛(wèi)生：每天營業(yè)前提前10分鐘把所管轄區(qū)域內(nèi)衛(wèi)生清理完畢，營業(yè)期間隨時保潔。下班后5-10分鐘清理桌面及衛(wèi)生區(qū)域。3.2 綠化區(qū)衛(wèi)生：每周徹底清理一遍，隨時保持清潔無垃圾。4 管理考核4.1 實行百分制考核，每月一次（四個分公司由客服部分別考核、集團職4.2 集團堅持定期檢查和不定期抽查的方式監(jiān)督各分公司、部門的衛(wèi)生工作。每周五為衛(wèi)生檢查日，集團檢查結(jié)果考核至各分公司，各分公司客服部的檢查結(jié)果考核至各部門。XXX 項目接口文檔版本控制信息版本 日期 描述 作者V1.0 2018-8-13 創(chuàng)建 XXX獲取所有字段獲取所有字段請求地址：/session/field/findAll請求參數(shù)參數(shù)名必填字段類型描述name是String根據(jù)名稱篩選響應(yīng)code10000 -1系統(tǒng)錯誤，10001必填參數(shù)為空message響應(yīng)描述result如響應(yīng)例子請求例子：:8080/session/field/findAll?name=X響應(yīng)例子：{"code":"10000","exception":null,"isSuccess":true,"message":" 成功，系統(tǒng)處理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"","iconSize":0,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0}文件上傳文件上傳（ajax）請求地址：/session/file/upload請求參數(shù)參數(shù)名 必填 字段類型 描述file 是 FormData FormData 對象包含的文件響應(yīng)code 10000 -1系統(tǒng)錯誤，10001必填參數(shù)為空message 響應(yīng)描述result 如響應(yīng)例子請求例子：varformData=newFormData();formData.append("file",this.files[0]);$.ajax({url:routePath+"/session/file/upload",type:'POST',data:formData,processData:false,contentType:false,success:function(result){result=JSON.parse(result);if(result.code=="10000"){layer.msg(' 上傳成功！');$("#editHeadPortrait").val(result.returnValue.filePath);}}});響應(yīng)例子：returnValue 里包含了fileName 和filePath字段管理所屬類型新增所屬類型請求地址：/session/fieldType/save請求參數(shù)參數(shù)名 必填 字段類型 描述name 是 String 所屬類型名稱響應(yīng)code 10000 -1系統(tǒng)錯誤，10001必填參數(shù)為空message 響應(yīng)描述result 如響應(yīng)例子請求例子：:8080/session/fieldType/save?name=13243434響應(yīng)例子：{"code":"10000","exception":null,"isSuccess":true,"message":" 成功，系統(tǒng)處理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}修改所屬類型請求地址：/session/fieldType/update請求參數(shù)參數(shù)名 必填 字段類型 描述id 是 Long 所屬類型idname 是 String 所屬類型名稱響應(yīng)code 10000 -1系統(tǒng)錯誤，10001必填參數(shù)為空message 響應(yīng)描述result 如響應(yīng)例子請求例子：:8080/session/fieldType/update?id=2&name=test響應(yīng)例子：{"code":"10000","exception":null,"isSuccess":true,"message":" 成功，系統(tǒng)處理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}根據(jù)id獲取所屬類型請求地址：/session/fieldType/getById請求參數(shù)參數(shù)名 必填 字段類型 描述id 是 Long 所屬類型id響應(yīng)code 10000 -1系統(tǒng)錯誤，10001必填參數(shù)為空message 響應(yīng)描述result 如響應(yīng)例子請求例子：:8080/session/fieldType/getById?id=2響應(yīng)例子：{"code":"10000","exception":null,"isSuccess":true,"message":" 成功，系統(tǒng)處理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":{"id":2,"name":"re"},"totals":0}獲取所屬類型列表請求地址：/session/fieldType/selectAll請求參數(shù)參數(shù)名 必填 字段類型 描述name 否 String 根據(jù)類型名稱篩選響應(yīng)code 10000 -1系統(tǒng)錯誤，10001必填參數(shù)為空message 響應(yīng)描述result 如響應(yīng)例子請求例子：:8080/session/fieldType/selectAll?name=1響應(yīng)例子：{"code":"10000","exception":null,"isSuccess":true,"message":" 成功，系統(tǒng)處理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":[{"id":1,"name":"123"},{"id":6,"name":"145555"}],"totals":2}刪除所屬類型（批量）請求地址：/session/fieldType/deleteByIds請求參數(shù)參數(shù)名 必填 字段類型 描述ids 是 List 所屬類型id集合響應(yīng)code 10000 -1系統(tǒng)錯誤，10001必填參數(shù)為空message 響應(yīng)描述result 如響應(yīng)例子請求例子：:8080/session/fieldType/deleteByIds?ids=1響應(yīng)例子：{"code":"10000","exception":null,"isSuccess":true,"message":" 成功，系統(tǒng)處理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}1 總則1.1 為了加強公司的環(huán)境衛(wèi)生管理，創(chuàng)造一個整潔、文明、溫馨的購物、辦公環(huán)境，根據(jù)《公共場所衛(wèi)生管理條例》的要求，特制定本制度。1.2 集團公司的衛(wèi)生管理部門設(shè)在企管部，并負(fù)責(zé)將集團公司的衛(wèi)生區(qū)域詳細(xì)劃分到各部室，各分公司所轄區(qū)域衛(wèi)生由分公司客服部負(fù)責(zé)劃分，確保無遺漏。2 衛(wèi)生標(biāo)準(zhǔn)2.1 室內(nèi)衛(wèi)生標(biāo)準(zhǔn)2.1.1 地面、墻面：無灰塵、無紙屑、無痰跡、無泡泡糖等粘合物、無積水，墻角無灰吊、無蜘蛛網(wǎng)。2.1.2 門、窗、玻璃、鏡子、柱子、電梯、樓梯、燈具等，做到明亮、無灰塵、無污跡、無粘合物，特別是玻璃，要求兩面明亮。2.1.3 柜臺、貨架：清潔干凈，貨架、柜臺底層及周圍無亂堆亂放現(xiàn)象、無灰塵、無粘合物，貨架頂部、背部和底部干凈，不存放雜物和私人物品。