• 请不要在回答技术问题时复制粘贴 AI 生成的内容
subpo
V2EX  ›  程序员

有没有好的 api 文档管理系统?

  •  
  •   subpo · Dec 18, 2014 · 7240 views
    This topic created in 4342 days ago, the information mentioned may be changed or developed.
    需求如下:
    1.可部署成web页面
    2.可用markdown书写api文档
    3.有后台,可以直接在网站上添加api
    24 replies  •  2015-09-07 12:39:55 +08:00
    Livid
    Livid
    MOD
    PRO
    Dec 18, 2014❤️2
    1
    https://dash.readme.io/

    可以做出很像 Stripe 文档网站的 API 文档站。
    aveline
    aveline
    Dec 18, 2014❤️3
    2
    xw
    xw
    Dec 18, 2014
    3
    关注
    subpo
    subpo
    OP
    Dec 18, 2014
    4
    我希望是面向内部使用的,多项目的api文档,而不是一个项目介绍文档
    subpo
    subpo
    OP
    Dec 18, 2014
    5
    @aveline
    @Livid
    我希望是面向内部使用的,多项目的api文档,而不是一个项目介绍文档,最好是能部署到自己服务器上的开源的项目(毕竟不想让别人看到私有的api文档),要求好像挺苛刻的,有吗...
    harryert
    harryert
    Dec 18, 2014
    6
    mark,我也想知道。。。
    lululau
    lululau
    Dec 18, 2014
    7
    Github Enterprise
    subpo
    subpo
    OP
    Dec 18, 2014
    8
    @aveline http://apidoc.io/ 很符合我的需求,要是这个网站能支持只有固定的登录用户才能看到文档就好了...
    efi
    efi
    Dec 18, 2014 via Android
    9
    Markdown写api?如果你写过就知道与Markdown语法搏斗的痛苦。试试列表和代码混写。
    youyongsong
    youyongsong
    Dec 18, 2014
    10
    How do you document your APIs? http://www.infoq.com/research/api-documentation
    个人觉得Swagger很不错,还可以直接集成到Django,Flask等框架里,有点像KSS。
    janxin
    janxin
    Dec 18, 2014
    11
    同意 @efi 的说法,markdown排版某些时候还是满痛苦的
    humiaozuzu
    humiaozuzu
    Dec 18, 2014
    12
    用过好多,发现还是 confluence 好用。。。
    yylyyl
    yylyyl
    Dec 19, 2014 via iPhone
    13
    Confluence +1
    JamesRuan
    JamesRuan
    Dec 19, 2014 via Android
    14
    自己撸了一个,没后台,没多项目,不支持markdown,但是支持一个比markdown更适合排版的自己发明的语言。
    egen
    egen
    Dec 19, 2014
    15
    mark一下,之前一直用 markdown 写文档,基本可以满足需求,不过觉得写的重复性的东西有点太多,看看有没有更好的方案
    XinRen
    XinRen
    Dec 19, 2014
    16
    关注
    subpo
    subpo
    OP
    Dec 19, 2014
    17
    你们只收藏不贡献!
    markdown不是必须,只要有个足够好用的编辑器就可以
    tanran
    tanran
    Dec 19, 2014
    18
    apidoc很好用
    KMHook
    KMHook
    Dec 19, 2014
    19
    mark,学习
    kimmykuang
    kimmykuang
    Dec 19, 2014
    20
    mark下,回去细细观之
    lguan
    lguan
    Dec 20, 2014
    21
    我用redmine写过api文档,就是textile,用github的写过,就是markdown,最后发现,还是confluence的最好用,markdown我很喜欢用,但是有些东西不好做,比如,表格
    zealic
    zealic
    Dec 20, 2014
    22
    https://github.com/gollum/gollum

    with:
    GitHub Flavored Markdown
    magicrolan
    magicrolan
    Mar 19, 2015
    23
    以后看看吧
    现在我也是迷茫
    qw0258
    qw0258
    Sep 7, 2015
    24
    mark ,学习
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   734 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 55ms · UTC 22:54 · PVG 06:54 · LAX 14:54 · JFK 17:54
    ♥ Do have faith in what you're doing.