Marser
V2EX  ›  Wikipedia

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

  •  
  •   Marser · Nov 8, 2016 · 8648 views
    This topic created in 3498 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
        1
    66beta  
       Nov 8, 2016
    什么? PHP ?

    Phabricator
    bugsnail
        2
    bugsnail  
       Nov 8, 2016
    apidoc

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