New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ApiX - 文档驱动开发 #13

Open
huangtengfei opened this Issue Feb 28, 2016 · 0 comments

Comments

Projects
None yet
1 participant
@huangtengfei
Owner

huangtengfei commented Feb 28, 2016

作为一名前端开发人员,如果你和我一样,早就厌倦了手工模拟数据(导致 js 中有一大堆代码都是 mock data),以及和后台对接时无休止地帮他们调试接口(因为可能他们的接口根本就没自己测通过),但又没法以理服人(没有事先写好规范的接口文档,导致出问题时,后台总说前端容易改就让前端改),那么,不妨试试 ApiX,一个全新的接口文档管理工具。

它主要有三个特点。

在线接口文档管理

登录后可以查看自己参与开发的系统,对系统中每一个前端需要用到的接口进行文档的创建、修改、删除和查看操作,清晰明了。

API 文档列表:

此处输入图片的描述

创建 API 文档:

此处输入图片的描述

模拟发送 HTTP 请求

对于每一个接口,可以让后台通过模拟发送 HTTP 请求对其进行测试,只有测试通过了(与文档一致)再交由前端调用。

此处输入图片的描述

Mock Api

对接口涉及到的数据表提供真实数据库的增删改查 Mock Api(基于 NodeJS & MongoDB),每创建一个接口分组(对应一张数据表),这些 API 自动实现并可用,(在后台接口测试通过前)调用这些API,就无需再手工模拟数据。

此处输入图片的描述

项目源码在 这里 ,里面有详细使用文档,欢迎试用。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment