产品推广 做了一个 swagger 的 API 文档云端撰写工具

run27017 · 2018年04月26日 · 最后由 gzyunke 回复于 2019年12月12日 · 6326 次阅读

不知道大家会不会用 swagger 生成 Restful 的 API 文档,反正我是写了一个云端的 Swagger 撰写工具,它支持:

  1. API 的私有性,对项目组外不可见
  2. 支持多人编写同一个文档的自动合并和冲突报警
  3. 编写超过一万行的文档不卡顿

本行放工具链接: SwaggerHuge

另外,我认为,撰写文档主要有三种方式:

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

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

最后,希望大家多提点意见,热切欢迎各种交流。我的邮箱是 run27017@126.com

多人协作版的 swagger editer?

lehug 回复

对的,进去需要创建组织,在组织内拉成员,然后创建 Api 项目。用着试试吧,多个人可以同时编辑同一个文档。

手写 yaml。。。。也不难。。。嗯。。。

这个写起来很麻烦,推荐你试下易文档 https://easydoc.top

需要 登录 后方可回复, 如果你还没有账号请 注册新账号