API文档管理工具折射出的技术视野

时间: 2019-08-31阅读: 115标签: api

什么是技术视野

网上看到不少关于如何提升技术视野的讨论,但却没有人给出定义,到底什么是技术视野?

所谓技术视野,就是看问题时所能切换的不同角(维)度。

下面就以API管理工具(以下简称“管理工具”)为例,来探讨背后隐藏的技术视野。


API管理工具

零视角

曾经在一个小型创业公司用到过最简单的管理工具,就是一个开源的文档管理工具,界面功能类似wiki(维基百科)。

这样的工具确实能满足核心需求——API在线文档化,并支持用户管理。

可是深想一层,对于管理工具的使用者——工程师,操作足够友好,功能足够完善吗?

使用这类管理工具很多时候都会出现文档与代码不一致的情况,也就是说工程师都不愿意去维护这个文档。

因为编写修改文档是个耗费时间的事情,短期来看,维护了既无利益,不维护也无危害~

所以有时候接口的变更通过口头协商而非文档协商。

小结:零视角其实谈不上视野,是大多数工程师的最容易形成的思维方式,特点就是只关注功能/问题本身。  

单一视角

当时为了解决上面的问题,同时为了练手所学的Node.js,我写了第一版的管理工具,并参加了线下沙龙分享。

现在看来其实当初的写的项目还是比较粗糙的,除了展示界面相较于wiki更加美观之外,主要加入了 Mock 功能。

更好的开源项目也有不少,比如阿里的RAP和国外的APIDOC。

之所以把它们归为一类讨论,那是因为它们都体现了开发者的单一视角。

RAP就是典型地站在前端工程师的角度开发的。

比如第一版是以页面来对接口进行分组,这种分组方式显然不合理,后端之间的服务调用不涉及页面怎么办呢?所以第二版对此进行了修改。

又比如和 MockJS 深度绑定,为前端工程师提供 Mock 功能。

MockJS 确实很不错,不但支持数据模拟,还支持数据校验,后端也是使用前端工程师所熟悉的 Node.js 编写。

缺点呢后面在讲其他管理工具的时候再对比分析。

APIDOC则是站在后端工程师角度来编写,增加了通过代码注释生成文档的功能。

小结:视角的建立意味着从0到1的质变,技术视野开始形成。此视野的工程师不再只关注功能实现或问题解决。  

多视角

偶然间读到 Martin Fowler大神的一篇关于契约测试的文章很受启发,文中提出了一种构想,通过管理工具来对前后端进行校验,从而保障文档与代码的一致性。

于是开发了第2版的管理工具。这一版同时从前后端两个角度设计。

对于前端不仅支持 Mock服务,同时还能对请求参数进行校验,甚至模拟服务端响应异常。 对于后端增加了类似 postman 调试接口功能,同时由于采用 JSON-Schema规范,可以直接将schema移植到后端代码中作为校验规则来校验参数。(RAP的局限性也在于此,MockJS的校验只能用于 Node.js和浏览器端,其它语言编写的服务端则无法使用。同时对于后端来说也没有如 Mock 服务器般好用的调试功能。)

当然它和一些知名的管理工具 Swagger 、 RAML还是有些差距,比如工具链不够丰富,不能通过注释生成代码。

小结:多视角的建立是从1到N的量变,而这个过程需要积累更多的经验,最终形成全局视野。  


总结

经常看到一些公司在招聘高级前端工程师的时候会要求掌握一门以上后的端语言或者说把掌握后端语言作为加分项,真正的用意不一定会要求前端工程师写后端代码,但掌握后端语言的前端工程师会多一个思考维度,也就是技术视野更丰富。

很多工程师以为自己和大神的差距是技术,但这种差距只是表象,而实质的差距是思维方式和技术视野。

技术视野不一样工程师,即使是做同样的事情,取得的成就也会不一样,这也是为什么我会在写书的时候注重帮助读者提升技术视野~

  • 一个工程师做事情如果总是只考虑把事情完成,零视角解决问题,最多只能成为中级工程师。

  • 能跳出事情本身,站在一个合理的角度进行思考,长久积累下来就能达到高级工程师的水准。

  • 考虑事情的前因后果以及所在系统中的各种联动关系,已然是架构师的视野了。


吐血推荐

1.站长广告联盟: 整理了目前主流的广告联盟平台,如果你有流量,可以作为参考选择适合你的平台点击进入...

2.休闲娱乐: 网页游戏  直播/交友   H5游戏

链接: http://www.fly63.com/article/detial/5609

webService和Restful

restful是一种架构风格,其核心是面向资源,更简单;而webService底层SOAP协议,主要核心是面向活动;两个都是通过web请求调用接口

使用 JS 来动态操作 css ,你知道几种方法?

JavaScript 可以说是交互之王,它作为脚本语言加上许多 Web Api 进一步扩展了它的特性集,更加丰富界面交互的可操作性。这类 API 的例子包括WebGL API、Canvas API、DOM API,还有一组不太为人所知的 CSS API

在 Node.js 上运行 Flutter Web 应用和 API

大量的跨平台应用开发框架,使你可以编写一次代码,然后在 Android,iOS 等多个平台上甚至在台式机上运行。你可能听说过一些流行的框架,例如 Ionic,Xamarin 和 React Native。另一个相对较新的框架是 Flutter

vue-next 函数式 api

在分享 vue-next 各个子模块的实现之前,我觉的有必要比较全面的整理下 vue-next 中提出的函数式 api,了解这些的话,无论是对于源码的阅读,还是当正式版发布时开始学习,应该都会有起到一定的辅助作用

解锁设计优质API的五种秘籍

如今,随着我们构建软件方式的变化,以及API平台的爆炸式激增,各大公司都必须以更快的速度构建出自己的产品、并推向市场。目前,几乎所有的软件需求都需要通过API来提供相应的解决方案,其中包括:支付类API、通信类API

Moment.js常用API速查

日常开发经常会用Moment.js来处理时间,现对频繁使用的几个API做下整理,以便日后查阅。

SDK 与API之间的关系和联系

SDK(Software Development Kit,软件开发工具包)一般都是一些软件工程师为特定的软件包、软件框架、硬件平台、操作系统等建立应用软件时的开发工具的集合,比如提供安卓开发工具、或者基于硬件开发的服务等。也有针对某项软件功能的SDK

基于 React 和 Redux 的 API 集成解决方案

在前端开发的过程中,我们可能会花不少的时间去集成 API、与 API 联调、或者解决 API 变动带来的问题。如果你也希望减轻这部分负担,提高团队的开发效率,那么这篇文章一定会对你有所帮助。文章中使用到的技术栈主要有:

Node.js中Streams

NodeJs流以难以使用而闻名,甚至更难理解。 好吧,我给你带来了好消息 - 现在已经不是这样了。多年来,开发人员创建了许多软件包,其唯一目的是为了更容易的使用流。 但是,在本文中,我将重点介绍NodJs 原生的流API。

ACE Editor在线代码编辑器的API使用文档

ACE 是一个开源的、独立的、基于浏览器的代码编辑器,可以嵌入到任何web页面或JavaScript应用程序中。ACE支持超过60种语言语法高亮,并能够处理代码多达400万行的大型文档

fly63.com版权所有,内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权,请与小编联系!情况属实本人将予以删除!

广告赞助文章投稿关于web前端网站点搜索站长推荐网站地图站长QQ:522607023

小程序专栏: 土味情话心理测试脑筋急转弯幽默笑话段子句子语录成语大全