zhuzhibin
V2EX  ›  问与答

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

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

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

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