java 单机接口限流处理方案
256
2023-03-14
本文目录一览:
Java语言提供了一种强大的注释形式:文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释,然后使用javadoc工具来生成自己的API文档。
文档注释以斜线后紧跟两个星号(/**)开始,以星号后紧跟一个斜线(*/)作为结尾,中间部分全部都是文档注释,会被提取到API文档中。
自行搜索一下javadoc即可,示例如下:
1234567891011121314151617181920212223242526272829/** * 类描述 * * @author 作者 * @version 版本 */public class DemoClass { /** * 内部属性:name */ private String name; /** * Setter方法 * @return name */ public String getName() { return name; } /** * Getter方法 * @param name */ public void setName(String name) { this.name = name; } }
这几天很有兴致的学习了百度云盘文件API接口的使用 初步是想做一个在线android应用 应用中的文档是存放在百度云盘的 主要是分一下几个步骤 注册百度账号 登录百度开发者中心 创建移动应用 获取对应的(API Key Secret Key) 开通pcs API权限 获取ACCESS_token(认证编码) 开发应用 注意 开通移动应用 获取key 获取token的时候我使用的安卓获取的方式 通过我写对应api的例子我发现 其实就两种情况 一种是get方式提交数据 另外一种是post方式提交数据 get方式提交数据 我们用获取云盘的信息为例 获取云盘信息前我们要知道 我们要准备好什么数据 请求参数 url: 标明我们要访问的网址路径 值固定问 method:标明我们是请求云盘信息 值固定为 info acceess_token:准入标识 值是我们自己申请的 接收返回参数 quota:云盘总容量 used:云盘使用容量 request_id:该请求的表示 没啥用 返回的一个json串如下格式 { quota : used : request_id : } 我在做的时候你使用Gson工具将json串转换到对应的entity类中了 代码如下 [] /** * @param URLConnection conn通过get方式获取StringBuffer * @return */ private StringBuffer getJsonString(URLConnection conn) { InputStreamReader isr = null; BufferedReader br = null; StringBuffer *** = null; try { isr = new InputStreamReader(conn getInputStream() gb ) br = new BufferedReader(isr) String line = null; *** = new StringBuffer() while ((line = br readLine()) != null) { *** append(line) *** append( \r\n ) } } catch (UnsupportedEncodingException e) { e printStackTrace() } catch (IOException e) { e printStackTrace() }finally{ try { if(isr!=null) isr close() } catch (IOException e) { System out println( 流关闭是异常 ) e printStackTrace() } } return *** ; } /** * @return * @throws Exception * 获取云空间的信息 */ public CloudInfo getCloudInfo() throws Exception { URL u = new URL( ?method=infoaccess_token=你申请的token的值 ; URLConnection conn = u openConnection() // 打开网页链接 // 获取用户云盘信息 String cloudJson = this getJsonString(conn) toString()
// 解析成对象 下面有这个实体对象的类 Gson gson = new Gson() CloudInfo cloudInfo = gson fromJson(cloudJson CloudInfo class) System out println( 云盘信息 +cloudInfo) return cloudInfo; } /** * @param URLConnection conn通过get方式获取StringBuffer * @return */ private StringBuffer getJsonString(URLConnection conn) { InputStreamReader isr = null; BufferedReader br = null; StringBuffer *** = null; try { isr = new InputStreamReader(conn getInputStream() gb ) br = new BufferedReader(isr) String line = null; *** = new StringBuffer() while ((line = br readLine()) != null) { *** append(line) *** append( \r\n ) } } catch (UnsupportedEncodingException e) { e printStackTrace() } catch (IOException e) { e printStackTrace() }finally{ try { if(isr!=null) isr close() } catch (IOException e) { System out println( 流关闭是异常 ) e printStackTrace() } } return *** ; } /** * @return * @throws Exception * 获取云空间的信息 */ public CloudInfo getCloudInfo() throws Exception { URL u = new URL( ?method=infoaccess_token=你申请的token的值 ; URLConnection conn = u openConnection() // 打开网页链接 // 获取用户云盘信息 String cloudJson = this getJsonString(conn) toString() // 解析成对象 下面有这个实体对象的类 Gson gson = new Gson() CloudInfo cloudInfo = gson fromJson(cloudJson CloudInfo class) System out println( 云盘信息 +cloudInfo) return cloudInfo; } [] package entity; import java lang reflect Type; /** * @author ydcun 获取云空间的信息 例如 * { quota : 空间配额 单位为字节 * used : 已使用空间大小 单位为字节 * request_id : } */ public class CloudInfo{ private Double quota; private Double used; private Double request_id; /** * @return the quota 空间配额 单位为字节 */ public Double getQuota() { return quota; } /** * @param quota the quota to set 空间配额 单位为字节 */ public void setQuota(Double quota) { this quota = quota; } /** * @return the used 已使用空间大小 单位为字节 */ public Double getused() { return used; } /** * @param used the used to set 已使用空间大小 单位为字节 */ public void setused(Double used) { this used = used; } /** * @return the request_id */ public Double getRequest_id() { return request_id; } /** * @param request_id the request_id to set */ public void setRequest_id(Double request_id) { this request_id = request_id; } @Override public String toString() { return new StringBuffer() append( 空间容量 ) append(this getQuota()/ / ) append( M; 已用 ) append(this getused()/ / ) append( M; ) toString() } } package entity; import java lang reflect Type; /** * @author ydcun 获取云空间的信息 例如 * { quota : 空间配额 单位为字节 * used : 已使用空间大小 单位为字节 * request_id : } */ public class CloudInfo{ private Double quota; private Double used; private Double request_id; /** * @return the quota 空间配额 单位为字节 */ public Double getQuota() { return quota; } /** * @param quota the quota to set 空间配额 单位为字节 */ public void setQuota(Double quota) { this quota = quota; } /** * @return the used 已使用空间大小 单位为字节 */ public Double getused() { return used; } /** * @param used the used to set 已使用空间大小 单位为字节 */ public void setused(Double used) { this used = used; } /** * @return the request_id */ public Double getRequest_id() { return request_id; } /** * @param request_id the request_id to set */ public void setRequest_id(Double request_id) { this request_id = request_id; } @Override public String toString() { return new StringBuffer() append( 空间容量 ) append(this getQuota()/ / ) append( M; 已用 ) append(this getused()/ / ) append( M; ) toString() } }
lishixinzhi/Article/program/Java/hx/201311/27162
一些刚开始写接口文档的服务端同学,很容易按着代码的思路去编写接口文档,这让客户端同学或者是服务对接方技术人员经常吐槽,看不懂接口文档。这篇文章提供一个常规接口文档的编写方法,给大家参考。
推荐使用的是docway 写接口文档,方便保存和共享,支持导出PDF MARKDOWN,支持团队项目管理。
一、请求参数
1. 请求方法
GET
用于获取数据
POST
用于更新数据,可与PUT互换,语义上PUT支持幂等
PUT
用于新增数据,可与POST互换,语义上PUT支持幂等
DELETE
用于删除数据
其他
其他的请求方法在一般的接口中很少使用。如:PATCH HEAD OPTIONS
2. URL
url表示了接口的请求路径。路径中可以包含参数,称为地址参数,如**/user/{id}**,其中id作为一个参数。
3. HTTP Header
HTTP Header用于此次请求的基础信息,在接口文档中以K-V方式展示,其中Content-Type则是一个非常必要的header,它描述的请求体的数据类型。
常用的content-type:
application/x-www-form-urlencoded
请求参数使用“”符号连接。
application/json
内容为json格式
application/xml
内容为xml格式
multipart/form-data
内容为多个数据组成,有分隔符隔开
4. HTTP Body
描述http body,依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。
示例:
二、响应参数
1. 响应 HTTP Body
响应body同请求body一样,需要描述请清除数据的类型。
另外,如果服务会根据不同的http status code 返回不同的数据结构, 也需要针对不同的http status code对内容进行描述。
三、接口说明
说明接口的应用场景,特别的注意点,比如,接口是否幂等、处理是同步方式还是异步方式等。
四、示例
上个示例(重点都用红笔圈出来,记牢了):
五、接口工具
推荐使用的是http://docway.net(以前叫小幺鸡) 写接口文档,方便保存和共享,支持导出PDF MARKDOWN,支持团队项目管理。
关于api接口文档如何使用和api接口文档生成工具的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得收藏关注本站。 api接口文档如何使用的介绍就聊到这里吧,感谢你花时间阅读本站内容,更多关于api接口文档生成工具、api接口文档如何使用的信息别忘了在本站进行查找喔。版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。
发表评论
暂时没有评论,来抢沙发吧~