V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
zhuzhibin
V2EX  ›  问与答

你们一般是用什么工具搭建自己的 API 文档?

  •  
  •   zhuzhibin · 2019-01-20 09:48:09 +08:00 · 4260 次点击
    这是一个创建于 2169 天前的主题,其中的信息可能已经有所发展或是发生改变。

    想找一些第三方的插件或者库,自己维护一套自己的项目文档,markdown 可能比较舒服

    20 条回复    2019-01-22 12:42:06 +08:00
    xiaomimei
        1
    xiaomimei  
       2019-01-20 09:54:00 +08:00 via Android
    Everyman
        2
    Everyman  
       2019-01-20 10:02:34 +08:00
    后端 swagger、前端 JSDoc
    zyp0921
        3
    zyp0921  
       2019-01-20 10:05:47 +08:00
    redmin 上的 wiki
    952764934
        4
    952764934  
       2019-01-20 10:35:25 +08:00
    yapi
    linmq
        5
    linmq  
       2019-01-20 10:41:52 +08:00 via iPhone
    Swagger
    FindHao
        6
    FindHao  
       2019-01-20 11:17:34 +08:00 via Android
    sphinx ?
    FindHao
        7
    FindHao  
       2019-01-20 11:18:21 +08:00 via Android
    sphinx 对 markdown 的支持不太好,我测试的时候,会有这样那样的问题出现,最后决定用 rst
    MrKou47
        8
    MrKou47  
       2019-01-20 12:07:33 +08:00 via iPhone
    可用 slate
    locoz
        9
    locoz  
       2019-01-20 12:09:02 +08:00 via Android
    之前用一些工具写过感觉不够舒服,准备用 python 的那个 docstring 语法写,然后 web 框架启动的时候读它来生成。。
    ooee2016
        10
    ooee2016  
       2019-01-20 13:26:01 +08:00 via iPhone
    eolinker
    loading
        11
    loading  
       2019-01-20 13:54:25 +08:00 via Android
    没人提 gitbook ?
    zhuzhibin
        12
    zhuzhibin  
    OP
       2019-01-20 18:50:33 +08:00 via iPhone
    @zyp0921 redmine 刚刚注册看了一下 感觉这像是团队协作类工具哦
    zhuzhibin
        13
    zhuzhibin  
    OP
       2019-01-20 18:51:08 +08:00 via iPhone
    @xiaomimei 谢谢朋友
    zhuzhibin
        14
    zhuzhibin  
    OP
       2019-01-20 18:51:42 +08:00 via iPhone
    @yiranHZT swg 可以拉代码下来搭自己服务器不 😎
    zhuzhibin
        15
    zhuzhibin  
    OP
       2019-01-20 18:52:08 +08:00 via iPhone
    @locoz 秀啊哥 教我爬爬数据呗🙃
    cnbattle
        16
    cnbattle  
       2019-01-20 22:40:11 +08:00 via Android
    apizza🌚
    huruwo
        17
    huruwo  
       2019-01-20 22:41:48 +08:00 via Android
    javadoc ?
    locoz
        18
    locoz  
       2019-01-20 23:17:50 +08:00 via Android
    @zhuzhibin #15 我不是,我没有,别瞎说啊.jpg 菜鸡一个,教不了
    endoffight
        19
    endoffight  
       2019-01-21 11:07:07 +08:00
    apidoc ?
    zhuzhibin
        20
    zhuzhibin  
    OP
       2019-01-22 12:42:06 +08:00 via iPhone
    @loading 已采用 gitbook 搭了一下
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2850 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 24ms · UTC 08:47 · PVG 16:47 · LAX 00:47 · JFK 03:47
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.