大家有用 Swagger 编写文档吗?我打算做一套 Swagger API 的云端撰写工具。

2018 年 4 月 20 日
 run27017

先放链接: https://run27017.tk/swaggerhuge

这是我做的一个 Swagger 文档云端撰写工具,目前实现的功能有:

目前实现的较为简陋,主要是看大家有没有使用 swagger 协作编写文档的需求。如果没有这方面的需求的话,我就仅仅作为自己团队能够使用的效果就好了。如果还是有这个需求的,我就进一步地完善它,加入我本就打算加入的几个核心关键功能。

目前来说,撰写文档主要有三种方式:

  1. 使用内嵌注释或者 DSL,然后工具生成
  2. 使用在线的文档撰写工具,如 swaggerhub
  3. 使用可视化的文档在线工具,如阿里的 RAP

就我个人来说,我的倾向顺序是 1,2,3. 有些人可能觉得可视化的东西很好,我还是不很习惯。

3141 次点击
所在节点    分享创造
5 条回复
run27017
2018 年 4 月 22 日
无人回复,来人一天
xuanyuanaosheng
2018 年 4 月 24 日
建议先做起来再来推广会好点
run27017
2018 年 4 月 26 日
@xuanyuanaosheng 嗯,近期加了不少功能,欢迎查看。
run27017
2018 年 4 月 26 日
发现原帖不能修改,这里补充下,产品增加了几个能力,包括:

1. 支持多人编写同一个文档的自动合并和冲突报警
2. 编写超过一万行的文档不卡顿
xuanyuanaosheng
2018 年 4 月 26 日
好的

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

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

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

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

© 2021 V2EX