api接口文档html模板,开发接口文档-api文档模板

api接口文档html模板,开发接口文档-api文档模板1、XXX项目接口文档版本控制信息版本日期描述作者V1.02018-8-13创建XXX1获取所有字段1.1获取所有字段请求地址:/session/field/findAll请求参数参数名必填字段类型描述name是String根据名称筛选响应code10000成功,-1系统错误,10001必填参数为空message响应描述result如响应例子请求例子:http:/127.0.0.1:8080/…

大家好,又见面了,我是你们的朋友全栈君。

1、XXX项目接口文档版本控制信息版本日期描述作者V1.02018-8-13创建XXX1 获取所有字段1.1 获取所有字段请求地址:/session/field/findAll请求参数参数名必填字段类型描述name是String根据名称筛选响应code10000成功,-1系统错误,10001必填参数为空message响应描述result如响应例子请求例子:http:/127.0.0.1:8080/session/field/findAll?name=X响应例子:code:10000,exception:null,isSuccess:true,message:成功,系统处理正常!,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:。

2、,id:7,name:XX,totals:02 文件上传2.1 文件上传(ajax)请求地址:/session/file/upload请求参数参数名必填字段类型描述file是FormDataFormData对象包含的文件响应code10000成功,-1系统错误,10001必填参数为空message响应描述result如响应例子请求例子:var formData = new FormData();formData.append(file, this.files0);$.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););响。

3、应例子:returnValue里包含了 fileName和filePath3 字段管理-所属类型3.1 新增所属类型请求地址:/session/fieldType/save请求参数参数名必填字段类型描述name是String所属类型名称响应code10000成功,-1系统错误,10001必填参数为空message响应描述result如响应例子请求例子:http:/127.0.0.1:8080/session/fieldType/save?name=13243434响应例子:code:10000,exception:null,isSuccess:true,message:成功,系统处理正常!,page:0,pageSize:0,returnListSize:0,returnObject:null,returnValue:null,totals:03.2 修改所属类型请求地址:/session/fieldType/update请求参数参数名必填字段类型描述id是Long所属类型idname是String所属类型名称响应code10000成功,-1系统错误,10001必填参数为空messag。

4、e响应描述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:03.3 根据id获取所属类型请求地址:/session/fieldType/getById请求参数参数名必填字段类型描述id是Long所属类型id响应code10000成功,-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,returnList。

5、Size:0,returnObject:null,returnValue:id:2,name:re,totals:03.4 获取所属类型列表请求地址:/session/fieldType/selectAll请求参数参数名必填字段类型描述name否String根据类型名称筛选响应code10000成功,-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:23.5 删除所属类型(批量)请求地址:/session/fieldType/deleteByIds请求参数参数名必填字段类型描述ids是List所属类型id集合响应code10000成功,-1系统错误,10001必填参数为空message响应描述result如响应例子请求例子:http:/127.0.0.1:8080/session/fieldType/deleteByIds?ids=1响应例子:code:10000,exception:null,isSuccess:true,message:成功,系统处理正常!,page:0,pageSize:0,returnListSize:0,returnObject:null,returnValue:null,totals:0。

《开发接口文档-api文档模板》由会员小**分享,可在线阅读,更多相关《开发接口文档-api文档模板》请在金锄头文库上搜索。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/161512.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)


相关推荐

  • isnotempty和isnotnull_isannotationpresent()用法

    isnotempty和isnotnull_isannotationpresent()用法转自:http://www.zhenhua.org/article.asp?id=625 isNotEmpty将空格也作为参数,isNotBlank则排除空格参数参考QuoteStringUtils方法的操作对象是java.lang.String类型的对象,是JDK提供的String类型操作方法的补充,并且是null安全的(即如果输入参数String为null则

  • 一款MVC5+EF+Bootstrap搭建的后台通用管理系统模板[通俗易懂]

    一款MVC5+EF+Bootstrap搭建的后台通用管理系统模板[通俗易懂]最近闲来无事,就用MVC5+EF+Bootstrap搭建了一个通用的后台管理系统的模板,里面使用到的技术包括:MVC,EF,T4模板批量生成Jquery,jqGridBootstrapDDDAutoMapper等开发工具:VS2015+SQL2012项目框架如下图:项目的效果图如下:JuCheapV2.0源代码http://……

  • jedispool使用自动归还jedis解决方案「建议收藏」

    jedispool使用自动归还jedis解决方案「建议收藏」在使用Jedispool的时候遇到一个尴尬的问题。实例必须要手动归还。即jedis高版本使用jedis.close()归还。这样据说是灵活的表现。但如果必须手动调close,那么万一项目组的成员手抖忘记掉了,这就无疑会出现很严重的情况,这无疑增加了系统的脆弱性。由于我们系统是用grpc做通信机制,所以不存在通过spring管理实例的生命周期来控制,经研究决定也决定不采用Redisson.那接

  • 面试题:深拷贝和浅拷贝(超级详细,有内存图)

    面试题:深拷贝和浅拷贝(超级详细,有内存图)这篇文章竟然写了一上午,亲,请怀着感恩的心阅读!!深拷贝和浅拷贝是经常在面试中会出现的,主要考察你对基本类型和引用类型的理解深度。我在无数次的面试中,应聘者还没有一个人能把这个问题回答情况,包括很多机构的培训老师。这篇文章会让你把基本类型和引用类型的区别搞得清清楚楚,搞清楚这两者的区别,你对任何编程语言的都不怕,因为,这不是js一门语言,是任何编程语言中都需要掌握的知识,而…

  • web网页设计代码模板_web网页设计源代码

    web网页设计代码模板_web网页设计源代码代码分享:https://pan.baidu.com/s/1xf4AQlfM8e6Nvw2oXUdbrA提取码:ap1v

  • SqlServer中Exists的使用

    SqlServer中Exists的使用1、简介不相关子查询:子查询的查询条件不依赖于父查询的称为不相关子查询 相关子查询:子查询的查询条件依赖于外层父查询的某个属性值的称为相关子查询。带Exists的子查询就是相关子查询 Exists表示存在量词:带有Exists的子查询不返回任何记录的数据,只返回逻辑值“True”或“False”2、表结构选课表:学号StudentNo、课程号CourseNo学生表:学号Stude…

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号