API代码自动化生成

日期:2015-12-25作者:Brad Irby翻译:崔婧雯 来源:TechTarget中国 英文

API开发   API自动化   

【TechTarget中国原创】

API已经非常流行,但是开发人员在缺少文档,以及产品经理需求不完整的时候,要想生成API代码任然是件痛苦的事情。本文探讨Swagger如何在应用创建的流程里,帮助保证代码和文档的一致性。

我们都认同API很好这一点,但是它的构建过程很痛苦。需要跟踪很多细节,在产品经理的想法变成文档规范,再变成开发人员代码的过程中,这些细节很容易就乱成一团。我们无法帮助改善文档环节(除非项目经理会写代码),但是如果使用Swagger的话,保持文档和代码的同步会很容易。

Swagger是一个工具,能够让任何拥有合适技术能力的人定义API,生成文档,并且甚至生成支持该API的代码。使用在线Swagger编辑器,你可以使用YAML设计API,这是一种人类可读的类似XML的语言。通过键入映射到部分URL的字符串,来定义端点(称为路径)。然后定义输入参数和输出数据的类型,想要实现的安全特性,然后就可以了。

用户可以查看的Swagger编辑器的一个示例是Instagram API(图1)。(如果你进入编辑器,选择File -> Open Example,还可以选择其他一些示例。)

图1. Swagger查看Instagram API代码

图1中的其他数据中,可以看到定义了八个路径(路径以单引号开头,点击行号后面的小的钻石图标,可以展开该节点以便查看细节)。打开这些路径的其中一个(图2),就可以看到其要求的GET HTTP动词。可以阅读描述,看到它要求三个参数。如果调用成功(响应为200),它就会返回一个对象数组,在最下面的Media定义部分定义。

API代码自动生成

图2.查看定义路径之一

类似得,可以打开Media的定义,查看该对象的属性细节,包括嵌入的对象(图3只显示了Media定义的一部分)。

API代码自动生成

图3. Media定义的部分视图

使用Swagger编辑器定义API很方便,但是它并不比其他工具更加容易。但是,在编辑器的右边栏,会自动生成所描述的API的HTML文档(图4)。文档很完整,易于阅读,并且提供了所描述API调用的尝试方式。点击底部的“Try this operation(试试该方法)”按钮,允许用户输入参数,发起调用,并且查看结果。

API代码自动生成

图4.自动生成的文档

这些特性都让这个工具很有用。使用Generate Server和Generate Client菜单选项(图5),能够以你喜欢的任意语言生成代码,从而提供或者消费该API。这个代码生成工具本身就能够帮助用户节约很多枯燥的编程时间,更不用说在API生命周期里做出很多变更时能够带给大家的帮助。另外,在使用导出功能创建本地文本文件时,整个流程完美得契合源代码控制策略。用户还可以发布文件,这样其他开发人员能够和你的数据轻松集成。

API代码自动生成

图5.使用Generate Server和Generate Client选项

编写API代码很有必要但是也很费时。使用Swagger设计API并且发布YAML能够让这个过程对于内部开发人员,以及想要消费你的数据的开发人员的工作更加简单。

我们一直都在努力坚持原创.......请不要一声不吭,就悄悄拿走。

我原创,你原创,我们的内容世界才会更加精彩!

【所有原创内容版权均属TechTarget,欢迎大家转发分享。但未经授权,严禁任何媒体(平面媒体、网络媒体、自媒体等)以及微信公众号复制、转载、摘编或以其他方式进行使用。】

微信公众号

TechTarget微信公众号二维码

TechTarget

官方微博

TechTarget中国官方微博二维码

TechTarget中国

评论
查看更多评论

敬请读者发表评论,本站保留删除与本文无关和不雅评论的权力。

作者>更多

Brad Irby
Brad Irby

Brad Irby has been a developer and systems architect since 1990, designing and implementing systems using the Microsoft stack.

API>更多

相关推荐

技术手册>更多

  • 企业架构师工具包

    企业架构师如何创建一个有用的工具集呢?目前实践者正在将UML和TOGAF以及其他工具连同使用,从而能够构建出软件模型解决业务构想变成工作系统最重要的一步。但是需要高度熟练的架构师,来创造业务架构参考模型。成功的软件架构师会发现和企业匹配的工作参考模型会成为他们自定制添加“工具”的框架。下面专家的一些建议可以为我们提供一些引导。

  • XML安全教程

    XML是确保Web服务安全的一个重要因素。XML是因特网以及近来Web服务持续增长和开发的主要支持者。

  • 评估成功:衡量BPM的利益

    我们已经在典型的商业预告中听到了一种变奏曲,即不可以改变或者改进无法衡量的东西。没有什么比BPM更能体现这句话了。在这本技术手册中,我们将提供可靠的最佳实践,精确衡量BPM的发展。专家将就如何削减BPM复杂性以及将BPM和重要的客户关系管理流程整合。同样,我们也会提供一些BPM趋势、愿景和技巧。

  • 复杂事件处理CEP手册

    在金融服务和其他行业中,如何使那些重要且具有战略意义的业务信息以高速数据流的方式到达企业变得尤其重要,而复杂事件处理(CEP)就是这一过程的代名词。在复杂事件处理中,数据是不断变化的,而“操作”是“静态”的。复杂事件处理具备了分析高速数据流并鉴别重要事件的能力,虽然对这些事件的鉴别过程是复杂的,但结果却是无价的。复杂事件处理能够帮助企业及时全面地洞察市场变化,降低风险和提高决策效率。下面我们就来介绍一下复杂事件处理。

TechTarget

最新资源
  • 安全
  • 存储
  • CIO
  • 数据库
  • 服务器
  • 云计算