我们出新产品啦,专业漂亮的 API 文档系统

2018-11-20 10:43:59 +08:00
 balabalaguguji

我是技术出生的,一直梦想自己能做点产品出来,不过我想到的产品都是跟技术相关的,这类产品一般属于小众,也赚不到什么钱,所以一般很少人去做好它,但是作为一个技术人员的情怀,我觉得有必要去用心做好它,创业一年多了,终于我们上新产品啦。这次我们要解救开发人员编写文档的痛苦。

我们的产品叫易文档: https://easydoc.xyz ,支持在线接口测试、自定义文档模板、预定义常用参数、分享文档。现在还是 beta 版,可能存在一些问题,大家可以跟我们反馈,我们会进行完善升级。

为什么我会选择做这个? 我们公司是外包+自研产品模式,经常需要些一些接口文档和使用手册,网上找过很多个,都不满意,所以我们决定自己做一套了。

我见过很多公司写接口文档还在用 word,excel,txt,要我用这种写接口文档,我是很痛苦的,首先是编写起来很麻烦,格式要编排好很费力,出来的文档也不漂亮,查找接口又麻烦,另外每次修改了一点东西,都要重新同步给协作者。 当然还有的公司直接就文档都不写,两个人直接坐在一起开发,直接口头传播,当然没问题,但是如果下个人接手你的项目,他就得看代码去了解接口有哪些参数了。

欢迎大家体验,给我们提建议,我们的目标是做最好的用的在线文档管理系统

8304 次点击
所在节点    分享创造
77 条回复
balabalaguguji
2018-11-21 19:14:04 +08:00
@nicoljiang #60 yapi 很多东西还没达到我们的高要求,对比用一下就知道,我们优势大很多
Eugene1024
2018-11-21 22:18:17 +08:00
支持下
qinxi
2018-11-21 22:23:54 +08:00
居然没有不需要登陆就能演示的 demo 页? 太差评了
storypanda
2018-11-22 00:00:54 +08:00
@balabalaguguji 看官网是模仿的 git book ?首页需要好好设计一下
balabalaguguji
2018-11-22 09:41:51 +08:00
@qinxi #63 首页底部有 demo
qinxi
2018-11-22 09:52:19 +08:00
@balabalaguguji #65 我说的演示是全套不用登录的,包括编辑和渲染。。你的 demo 是经过渲染之后的
balabalaguguji
2018-11-22 10:06:45 +08:00
@qinxi #66 不登录就编辑的暂时没有,另外登录非常简单了,第三方登录点击一下就进去了。
levywang
2018-11-22 10:15:26 +08:00
你好,非常好用。
但是手机页面的适配不是很好,图片会溢出整个 body
balabalaguguji
2018-11-22 10:19:56 +08:00
@levywang #68 感谢支持,手机上还没做兼容,人手不够,先做好 PC 端,后面会完善手机端
aqqwiyth
2018-11-22 13:03:13 +08:00
接口测试在哪呢..
sunny2580839896
2018-11-22 14:34:51 +08:00
@balabalaguguji 那就太好了
balabalaguguji
2018-11-22 15:01:30 +08:00
@aqqwiyth #70 HTTP 文档编辑页面和预览页面都有
M0
2018-11-22 15:40:44 +08:00
bug 反馈: 点击 A 文档后,向下滚动,页面停留在 x 位置,点击 B 文档,希望此时页面跳转到 B 文档的头部,但是页面会显示 B 文档的 x 位置。
balabalaguguji
2018-11-23 09:49:16 +08:00
@M0 #73 收到,最近我们会修复
balabalaguguji
2018-11-23 12:06:52 +08:00
@M0 #73 已修复
SingeeKing
2018-11-26 16:57:05 +08:00
做得很好,希望什么时候有开源自部署了可以 At 一下我
balabalaguguji
2018-11-27 19:36:30 +08:00
@SingeeKing #76 好的

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/509512

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX