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

code message
XXX项目接口文档
1获取所有字段
1.1获取所有宇段
请求地址:/session/field/findAII
响应
10000成功f -1系统错误，10001必填参数为空
响应描述
如响应例子
请求例子:http://127.0.0.1:8080/session/field/findAII?name=X 响应例子：
{\ode H:-10000M f M exception":null f M isSuccess-:true/,message rt：-^ f系统处理正常！
"/page":0/pageSize":0/returnObject":null/retumValue•:{"types^null/villages^null/companys^H^conC olour 丫Ticon SizelOJconStyle•:•丁icT:4「name 丫XXXiconColour 丫TiconSizelO/iconStyle•: ■:・icT:5/ nameTXX”},{”iconColourTTiconSize・：（TiconStyle”：・Ticr：7「name・：-X X”}]}「totals・：0}
2文件上传
2.1文件上传（ajax）
请求地址:/session/file/upload 请求参数
formData.append("file M f this.files[O]);
$.ajax({
url: routePath + "/session/file/upload"f
type : TOST；
data : formData,
processData : false,
contentType : false, success : function (result) {
result = JSON.parse(result);
if(result.code== -10000M){
layer.msg(上传成功！ *);
$(M#editHeadPortrait M).val(result.returnValue.filePath);
}
}
});
响应例子：returnValue 里包含了fileName 和filePath
3字段管理•所属类型
3.1新熠所属类型
请求地址:/session/fieldType/save
响应
响应例子：{"code^^lOOOO'/'exception^null/isSuccess^true/'message*:*^^ ,系统处理正箒! "/page^O/pageSize^O/returnListSize^O/returnObject^null/returnValue^null/totals^O}
3.2修改所属类型
请求地址:/session/fieldType/update 请求参数
响应
请求例子：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/returnListSize B:0/retumObject":null/returnValue R:null r"totals":0}
3.3根据id获取所属类型
请求: /session/fieldType/getByld 请求参数
响应例子：{"code^/lOOOO'/'exception^null/isSuccess^true/^message'/fiJ^t) f 系统处理正常！ "/page H :0/pageSize ,,:0/returnListSize":0/returnObject M :null/returnValue"：rid e :2/',name":,,re -}f H totals ,,:0}
3.4获取所属类型列表
请求: /session/fieldType/selectAII
请
数
请求例子：http://127.0.0.1:8080/session/fieldType/selectAII?name=l 响应例子：{"code^/lOOOO'/'exception^null/isSuccess^true/'message^'sJ^J f 系统处理正箒! ；-page":0/pageSize":0/returnObject R :null/returnValue\[rid":l ；name\"123"}X"id\6r w name"：-145555"}] /totals":2}
3.5
删除所属类型（批星）
请求地址:/session/fieldType/deleteBylds 请求参数
响应例子：{"code^/lOOOO'/'exception^null/isSuccess^true/'message'/fiJ^i] f 系统处理正常！ "/page^O/pageSize^O/retumListSize^O/returnObject^null/returnValue^null/totals^O}。