zhuzhibin
V2EX  ›  问与答

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

  •  
  •   zhuzhibin · Jan 20, 2019 · 4775 views
    This topic created in 2746 days ago, the information mentioned may be changed or developed.

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

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