开发接口文档-API文档模板

XXX项目接口文档版本控制信息版本日期描述作者V1.02018-8-13创建XXX1获取所有字段1.1获取所有宇段请求地址:/session/field/findAII请求参数荃数名必填宇段类型描述name是String根据名称筛选响应codemessageresult10000成功f-1系统错误，10001必填参数为空响应描述如响应例子请求例子:HYPERLINK"http://127.0.0.1:8080/session/field/findAII?name=X"http://127.0.0.1:8080/session/field/findAII?name=X响应例子：{\odeH:-10000MfMexception":nullfMisSuccess-:true/,messagert：-^f系统处理正常！"/page":0/pageSize":0/returnObject":null/retumValue•:{"types^null/villages^null/companys^H^conColour丫TiconSizelOJconStyle•:•丁icT:4「name丫XXXiconColour丫TiconSizelO/iconStyle•:■:・icT:5/nameTXX”},{”iconColourTTiconSize・：（TiconStyle”：・Ticr：7「name・：-XX”}]}「totals・：0}2文件上传2.1文件上传（ajax）请求地址:/session/file/upload请求参数荃数名必填宇段类型描述file是FormDataFormData对象包含的文件响应code10000成功,-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：varformData=newFormDataQ;formData.append("fileMfthis.files[O]);$.ajax({url:routePath+"/session/file/upload"ftype:TOST；data:formData,processData:false,contentType:false,success:function(result){result=JSON.parse(result);if(result.code==-10000M){layer.msg(上传成功！*);$(M#editHeadPortraitM).val(result.returnValue.filePath);}}});响应例子：returnValue里包含了fileName和filePath3字段管理•所属类型3.1新熠所属类型请求地址:/session/fieldType/save请求参数奎数名必填宇段类型描述name是String所属类型名称响应codemessage10000成功,-1系统错误，10001必填夢数为空响应描述result如响应例子请求例子：HYPERLINK"http://127.0.0.1:8080/session/fieldType/save?name=13243434"http://127.0.0.1:8080/session/fieldType/save?name=13243434响应例子：{"code^^lOOOO'/'exception^null/isSuccess^true/'message*:*^^,系统处理正箒!"/page^O/pageSize^O/returnListSize^O/returnObject^null/returnValue^null/totals^O}3.2修改所属类型请求地址:/session/fieldType/update请求参数荃数名必填宇段类型描述id是Long所属类型idname是String所属类型名称响应code110000成功,-1系统错误，10001必填参数为空message1响应描述result如响应例子请求例子：http://127.0.0.1:8080/session/fieldType/update?id=2&name二test响应例子：{"code^/lOOOO^'exception^null/isSuccess^true/'message^/fiE%f系统处理正常！•/page":0/pageSize":0/returnListSizeB:0/retumObject":null/returnValueR:nullr"totals":0}3.3根据id获取所属类型请求:/session/fieldType/getByld请求参数垒数名必填宇段类型描述id是Long所属类型id响应code10000成功,-1系统错误，10001必填夢数为空message响应描述result如响应例子请求例子:HYPERLINK"http://127.0.0.1:8080/session/fieldType/getById?id=2"http://127.0.0.1:8080/session/fieldType/getById?id=2响应例子：{"code^/lOOOO'/'exception^null/isSuccess^true/^message'/fiJ^t)f系统处理正常！"/pageH:0/pageSize,,:0/returnListSize":0/returnObjectM:null/returnValue"：ride:2/',name":,,re-}fHtotals,,:0}3.4获取所属类型列表请求:/session/fieldType/selectAII请求参数荃数名必填宇段类型描述name否String根据类型名称筛选响应code10000成功,-1系统错误，10001必填参数为空message响应描述result如响应例子请求例子：HYPERLINK"http://127.0.0.1:8080/session/fieldType/selectAII?name=l"http://127.0.0.1:8080/session/fieldType/selectAII?name=l响应例子：{"code^/lOOOO'/'exception^null/isSuccess^true/'message^'sJ^Jf系统处理正箒!；-page":0/pageSize":0/returnObjectR:null/returnValue\[rid":l；name\"123"}X"id\6rwname"：-145555"}]/totals":2}3.5删除所属类型（批星）请求地址:/session/fieldType/deleteBylds请求参数荃数名必填宇段类型描述ids是List所属类型id隼合响应code10000成功,-1系统错误，10001必填参数为空messageresult响应描述如响应例子请求例子:HYPERLINK"http://127.0.0.1:8080/sesslon/fieldType/deleteBylds?ids=1"http://127.0.0.1:8080/sesslon/fieldType/deleteBylds?ids=1响应例子：{"code^/lOOOO'/'exception^null/isSuccess^true/'message'/fiJ^i]f系统处理正常！"/page^O/pageSize^O/retumListSize^O/returnObject^null/returnValue^null/totals^O}