Marser
V2EX  ›  Wikipedia

请教各位写接口文档时用的 wiki 系统是什么?

  •  
  •   Marser · Nov 8, 2016 · 9151 views
    This topic created in 3647 days ago, the information mentioned may be changed or developed.

    请教各位写接口文档时,用的 wiki 系统是什么?公司自己开发的?还是使用的开源系统? 有没有开源的 wiki 系统推荐?最好是 php 开发的, node 的也接受~

    12 replies  •  2016-11-09 10:53:10 +08:00
    66beta
    66beta
    Nov 8, 2016
    1
    什么? PHP ?

    Phabricator
    bugsnail
    bugsnail
    Nov 8, 2016
    2
    apidoc

    就是注释写的有点麻烦
    Marser
    Marser
    OP
    Nov 8, 2016
    3
    @66beta 这是代码审查工具吧?
    xfspace
    xfspace
    Nov 8, 2016 via Android
    4
    自己做一个...
    Markdown ,用 Elasticsearch 做搜索。
    Marser
    Marser
    OP
    Nov 8, 2016
    5
    @xfspace 好 6
    Marser
    Marser
    OP
    Nov 8, 2016
    6
    @bugsnail 好的,谢谢
    glasslion
    glasslion
    Nov 8, 2016
    7
    1. 文档不应和代码分离。 放在外部 wiki ,容易忘记维护 。
    2. wiki 语法太复杂。一般说明性的文档用 markdown 就足够了, 用 gitlab, Phabricator 查看起来很方便
    3. REST API 接口 用 swagger , 这已成为事实标准
    morewe
    morewe
    Nov 8, 2016
    8
    自己写了个。
    jininij
    jininij
    Nov 8, 2016 via Android
    9
    dokuwiki 。无数据库,插件丰富,语法简单完整。
    yubang
    yubang
    Nov 8, 2016
    10
    自己造一个轮子,能看就好
    66beta
    66beta
    Nov 9, 2016
    11
    @Marser 有 wiki 功能的,一步到位
    Marser
    Marser
    OP
    Nov 9, 2016
    12
    @66beta 好的,谢谢~~
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   1387 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 45ms · UTC 21:21 · PVG 05:21 · LAX 13:21 · JFK 16:21
    ♥ Do have faith in what you're doing.