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

精品文档 1欢迎下载 XXXXXX 项目接口文档项目接口文档 版本控制信息版本控制信息 版本日期描述作者 V1 02018 8 13 创建 XXX 1 1获取所有字段获取所有字段 1 11 1获取所有字段获取所有字段 请求地址 session field findAll 请求参数 参数名参数名必填必填字段类型字段类型描述描述 name 是 String 根据名称筛选 响应 code 10000 成功 1 系统错误 10001 必填参数为空 message 响应描述 result 如响应例子 请求例子 http 127 0 0 1 8080 session field findAll name X 精品文档 2欢迎下载 响应例子 code 10000 exception null isSuccess true message 成功 系统处理正常 page 0 pageSize 0 returnObject null returnValue types null villages null companys iconCo lour 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 2 2文件上传文件上传 2 12 1文件上传 文件上传 ajaxajax 请求地址 session file upload 请求参数 参数名参数名必填必填字段类型字段类型描述描述 file 是 FormData FormData 对象包含的文件 响应 code 10000 成功 1 系统错误 10001 必填参数为空 message 响应描述 result 如响应例子 请求例子 var formData new FormData formData append file this files 0 ajax url routePath session file upload type POST data formData 精品文档 3欢迎下载 processData false contentType false success function result result JSON parse result if result code 10000 layer msg 上传成功 editHeadPortrait val result returnValue filePath 响应例子 returnValue 里包含了 fileName 和 filePath 3 3字段管理字段管理 所属类型所属类型 3 13 1新增所属类型新增所属类型 请求地址 session fieldType save 请求参数 参数名参数名必填必填字段类型字段类型描述描述 name 是 String 所属类型名称 响应 code 10000 成功 1 系统错误 10001 必填参数为空 message 响应描述 result 如响应例子 请求例子 http 127 0 0 1 8080 session fieldType save name 13243434 精品文档 4欢迎下载 响应例子 code 10000 exception null isSuccess true message 成功 系统处理正常 page 0 pageSize 0 returnListSize 0 returnObject null returnValue null totals 0 3 23 2修改所属类型修改所属类型 请求地址 session fieldType update 请求参数 参数名参数名必填必填字段类型字段类型描述描述 id 是 Long 所属类型 id name 是 String 所属类型名称 响应 code 10000 成功 1 系统错误 10001 必填参数为空 message 响应描述 result 如响应例子 请求例子 http 127 0 0 1 8080 session fieldType update id 2 name test 响应例子 code 10000 exception null isSuccess true message 成功 系统处理正常 page 0 pageSize 0 returnListSize 0 returnObject null returnValue null totals 0 3 33 3根据根据 idid 获取所属类型获取所属类型 请求地址 session fieldType getById 请求参数 参数名参数名必填必填字段类型字段类型描述描述 id 是 Long 所属类型 id 精品文档 5欢迎下载 响应 code 10000 成功 1 系统错误 10001 必填参数为空 message 响应描述 result 如响应例子 请求例子 http 127 0 0 1 8080 session fieldType getById id 2 响应例子 code 10000 exception null isSuccess true message 成功 系统处理正常 page 0 pageSize 0 returnListSize 0 returnObject null returnValue id 2 name re totals 0 3 43 4获取所属类型列表获取所属类型列表 请求地址 session fieldType selectAll 请求参数 参数名参数名必填必填字段类型字段类型描述描述 name 否 String 根据类型名称筛选 响应 code 10000 成功 1 系统错误 10001 必填参数为空 message 响应描述 result 如响应例子 请求例子 http 127 0 0 1 8080 session fieldType selectAll name 1 响应例子 code 10000 exception null isSuccess true message 成功 系统处理正常 page 0 pageSize 0 returnObject null returnValue id 1 name 123 id 6 name 145555 totals 2 3 53 5删除所属类型 批量 删除所属类型 批量 请求地址 session fieldType deleteByIds 精品文档 6欢迎下载 请求参数 参数名参数名必填必填字段类型字段类型描述描述 ids 是 List 所属类型 id 集合 响应 code 10000 成功 1 系统错误 10001 必填参数为空 message 响应描述 result 如响应例子 请求例子 http 127 0 0 1 8080 session fieldType deleteByIds ids 1 响应例子 code 10000 exception null isSuccess true message 成功 系统处理正常