春争日,夏争时,扫码抽取夏日礼包!!! 了解详情
写点什么

交互式 I/O 文档——Mashery 重新定义 API 文档

  • 2011 年 7 月 29 日
  • 本文字数:1082 字

    阅读完需:约 4 分钟

Mashery 于 2011 年 7 月 25 日发布了其I/O 文档工具,这也是对Mashery API 管理SaaS 平台提供的新增支持。 I/O 文档旨在为开发人员提供一个接口,通过该接口可以直接在 API 文档中执行实时 API 调用,从而实现加速应用。

针对该工具及其特点,InfoQ 对 Mashery 产品管理主管 Neil Mansilla 进行了采访。

InfoQ:什么是 I/O 文档?该项目的动因又是什么呢?

Mashery I/O 文档是一种交互式的文档,可以帮助开发人员更加快速有效地理解和学习 API。我们可以直接从 API 文档执行实时的 API 调用,相较干巴巴的静态示例这种方式可以提供实时的载荷数据。I/O 文档能够帮助我们的客户和 API 提供者,这样发布的文档外观清晰、简洁,且在内容资源、方式方法和参数层面又能够做到细致入微。
在我们此前的调研中,我们了解到 API 文档通常缺乏方法上的专用性和 API 调用样例。使用 Mashery I/O 文档,对方法的分析,可深入到参数层次,从而为开发人员良好地定义并清晰地展现出来。至于 API 调用样例,I/O 文档就是个实时样例生成器——通过实时 API 调用,开发人员能够创建自己直接可运行的样例。我们推出 I/O 文档的动因就是希望能够帮助我们客户的平台和开发人员取得成功。

下面列举了该工具其他一些对 API 提供者带来的好处:

  • 清晰的 API 文档,测试、调试以及开发都集中在一起
  • 缩短开发人员首次 API 调用时间
  • 更快的应用开发
  • 减少技术支持
  • 具备一个强大的沟通渠道可供内部技术支持、QA 以及技术写手来实现与 API 变更的交流
  • 确保 API 文档反应当前的 API 版本
  • 清晰、优美的 API 文档设计

InfoQ: 该工具是否同样适用于公共 API 和企业内部 API 呢?是否支持非 REST(non-RESTful)APIs?

Mashery I/O 文档对私有企业 API 和公共 API 都适用。Mashery I/O 文档目前支持 RESTful APIs。很快 I/O 文档将实现对 SOAP 的支持。Mashery I/O 文档是可扩展的,并且能够适用于支持非标准的协议。

InfoQ:能否请您描述一下有关将一个传统 API 文档,比如 Java 文档,迁移到 I/O 文档的相关技术细节?

Mashery I/O 文档使用一种 JSON schema 来描述 API 资源、方法和参数。该 schema 可被扩展来处理各种 API 的各种独到特征。创建一个面向 I/O 文档的 JSON 配置是最直截了当的方法。

InfoQ:还有什么有关 IO 文档未来发展蓝图是您觉得可以与社区分享的吗?

我们的 I/O 文档发展蓝图包括:提供补充加密方法的支持、支持 SOAP、能够实现随地部署(甚至在 Mashery 环境堆栈以外)。

一些早期的 I/O 文档实现已经可以公开获得了,其中包括从

Klout

Alibris 以及

Fanfeeder 获取 API 文档。

查看英文原文: Mashery Redefines API Documentation with Interactive I/O Docs

2011 年 7 月 29 日 22:022096
用户头像

发布了 52 篇内容, 共 15.6 次阅读, 收获喜欢 3 次。

关注

评论

发布
暂无评论
发现更多内容

发量能决定一个程序员的水平吗

Java 程序员 后端

可以回答一下:Redis和mysql数据是怎么保持数据一致的嘛?

Java 程序员 后端

【Redis源码分析专题】(1)从本质分析你写入Redis中的数据为什么不见了?

浩宇天尚

redis Redis 核心技术与实战 11月日更 缓存驱逐

如何避免企业在碳排放数据上造假?

石云升

学习笔记 碳中和 碳交易

双非本科进不了大厂?阿里技术四面+交叉面+HR面,成功拿到offer

Java spring 程序员 mybatis

吊打 ThreadLocal,谈谈FastThreadLocal为啥能这么快?

Java 程序员 后端

吐血总结——90%程序员面试都用得上的索引优化手册

Java 程序员 后端

Apache Pulsar 在 BIGO 的性能调优实战(下)

Apache Pulsar

分布式 中间件 BIGO Apache Pulsar 消息系统 Apache BookKeeper

原来书中说的JVM默认垃圾回收器是错的!

Java 程序员 后端

双非本科毕业的我,为何能在金九银十期间斩获京东、字节、快手的offer

Java 程序员 后端

企业数字化转型的起手式是什么?

百度大脑

人工智能 百度

同程内网流传的分布式凤凰缓存系统手册,竟遭GitHub强行开源下载

Java 程序员 后端

喝了杯咖啡,我突然对MySQL锁、事务、MVCC-有了新的认识!

Java 程序员 后端

工作五年之后,对技术和业务的思考

知了一笑

程序员 技术 职场 互联网人 业务

又一巅峰神作!14年工作经验大佬出品“JVM&G1 GC深入学习手册”

Java 程序员 后端

史上最全Java面试266题:算法+缓存+TCP+JVM

Java 程序员 后端

万文讲解知乎实时数仓架构演进

大数据老哥

工作10年,面试超过500人想进阿里的同学,总结出的108道面试题

Java MySQL redis spring JVM

可以回答一下:Redis和mysql数据是怎么保持数据一致的嘛?(1)

Java 程序员 后端

【高并发】SimpleDateFormat类到底为啥不是线程安全的?(附六种解决方案,建议收藏)

冰河

Java 并发编程 多线程 高并发 异步编程

同一个Spring-AOP的坑,我一天踩了两次,深坑啊

Java 程序员 后端

网络安全漏洞复现与分析

网络安全学海

网络安全 信息安全 渗透测试 WEB安全 漏洞挖掘

同事问我如何Java实现,搞定分析栈和队列数据结构的实现过程不就好了

Java 程序员 后端

哪有什么中年危机,不过是把定目标当成了有计划

Java 程序员 后端

双非本科七面成功入职阿里面经分享!(附面试原题+复盘笔记)

Java 程序员 后端

活动预告|ArchSummit全球架构师峰会

第四范式开发者社区

同一份数据,Redis为什么要存两次

Java 程序员 后端

数据服务基础能力之元数据管理

知了一笑

数据分析 数据 元数据 数据管理 业务数据

哭了,我居然回答不出来女同事的问题:索引为什么能提供查询性能---

Java 程序员 后端

听我讲完GET、POST原理,面试官给我倒了杯卡布奇诺

Java 程序员 后端

四、StringRedisTemplate 和RedisTemlate有什么不同

Java 程序员 后端

交互式I/O文档——Mashery重新定义API文档_SOA_Jeevak Kasarkod_InfoQ精选文章