来自 Web前端 2020-05-07 05:42 的文章
当前位置: 网上澳门金莎娱乐 > Web前端 > 正文

API文档管理工具折射出的技术视野网上澳门金莎娱乐

时间: 2019-08-31阅读: 155标签: api什么是技术视野

一、基础概念篇
概述
学习此工具的背景
目前大部分公司都实行了前后端分离开发
a、前端开发依赖于后端接口数据,需要与后端接口联调才能获得数据展示,从而拖慢了开发进度;
b、没有一个很好的结构化接口文档管理工具,能够对项目中所用到的接口进行管理。如一个请求的地址、有几个参数、参数名称及类型含义等等。同时支持项目、历史版本的切换。
1、什么是RAP
RAP是一个GUI的WEB接口管理工具。在RAP中,您可定义接口的URL、请求&响应细节格式等等。通过分析这些数据,RAP提供MOCK服务、测试服务等自动化工具。RAP同时提供大量企业级功能,帮助企业和团队高效的工作。
在前后端分离的开发模式下,我们通常需要定义一份接口文档来规范接口的具体信息。如一个请求的地址、有几个参数、参数名称及类型含义等等。RAP 首先方便团队录入、查看和管理这些接口文档,并通过分析结构化的文档数据,重复利用并生成自测数据、提供自测控制台等等... 大幅度提升开发效率。
主站地址:http://rapapi.org/
GitHub地址:https://github.com/thx/RAP
2、RAP特色
a.强大的GUI工具 给力的用户体验,你将会爱上使用RAP来管理您的API文档。
b.完善的MOCK服务 文档定义好的瞬间,所有接口已经准备就绪。有了MockJS,无论您的业务模型有多复杂,它都能很好的满足。
c.庞大的用户群 RAP在阿里巴巴有200多个大型项目在使用,也有许多著名的公司、开源人士在使用。RAP跟随这些业务的成行而成长,专注细节,把握质量,经得住考验。
3.怎么用
RAP学习中心:http://thx.github.io/RAP/study.html
WIKI: https://github.com/thx/RAP/wiki/home_cn
Mock.js介绍和语法: http://mockjs.com/
http://mockjs.com/0.1/
在线实例(参考):http://rapapi.org/org/team/teams.do (需要先注册)
4.搭建内部使用的rap
二、入门使用篇
1、创建项目

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

网上澳门金莎娱乐 1

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

image.png

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

2、进入项目点击编辑添加接口地址请求参数以及响应

API管理工具零视角

网上澳门金莎娱乐 2

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

image.png

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

3、存储可以不同版本之前切换

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

网上澳门金莎娱乐 3

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

image.png

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

4、点击进入请求页面

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

网上澳门金莎娱乐 4

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

image.png

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

网上澳门金莎娱乐 5

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

image.png

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

产生mock数据

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

网上澳门金莎娱乐 6

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

image.png

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

此接口管理工具主要是在开发的前端和后端联调使用以及接口文档的统一管理比较方便

本文由网上澳门金莎娱乐发布于Web前端,转载请注明出处:API文档管理工具折射出的技术视野网上澳门金莎娱乐

关键词: