V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
run27017
V2EX  ›  分享创造

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

  •  1
     
  •   run27017 · 2018-04-20 16:45:56 +08:00 · 2180 次点击
    这是一个创建于 2169 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

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

    • 支持组织,文档对外是私有的,在组织内是开放的

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

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

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

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

    5 条回复    2018-04-26 19:47:58 +08:00
    run27017
        1
    run27017  
    OP
       2018-04-22 21:59:10 +08:00
    无人回复,来人一天
    xuanyuanaosheng
        2
    xuanyuanaosheng  
       2018-04-24 09:00:23 +08:00 via Android
    建议先做起来再来推广会好点
    run27017
        3
    run27017  
    OP
       2018-04-26 15:14:44 +08:00
    @xuanyuanaosheng 嗯,近期加了不少功能,欢迎查看。
    run27017
        4
    run27017  
    OP
       2018-04-26 15:16:09 +08:00
    发现原帖不能修改,这里补充下,产品增加了几个能力,包括:

    1. 支持多人编写同一个文档的自动合并和冲突报警
    2. 编写超过一万行的文档不卡顿
    xuanyuanaosheng
        5
    xuanyuanaosheng  
       2018-04-26 19:47:58 +08:00 via Android
    好的
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   5321 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 37ms · UTC 01:28 · PVG 09:28 · LAX 18:28 · JFK 21:28
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.