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

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

这是一个创建于 2935 天前的主题，其中的信息可能已经有所发展或是发生改变。

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

12 条回复 • 2016-11-09 10:53:10 +08:00

66beta

2016-11-08 16:53:10 +08:00

什么？ PHP ？

Phabricator

bugsnail

2016-11-08 16:58:47 +08:00

apidoc

就是注释写的有点麻烦

Marser

2016-11-08 17:03:04 +08:00

@66beta 这是代码审查工具吧？

xfspace

2016-11-08 17:08:52 +08:00 via Android

自己做一个...
Markdown ，用 Elasticsearch 做搜索。

Marser

2016-11-08 17:28:53 +08:00

Marser

2016-11-08 17:29:03 +08:00

@bugsnail 好的，谢谢

glasslion

2016-11-08 18:52:11 +08:00

1. 文档不应和代码分离。放在外部 wiki ，容易忘记维护。
2. wiki 语法太复杂。一般说明性的文档用 markdown 就足够了，用 gitlab, Phabricator 查看起来很方便
3. REST API 接口用 swagger ，这已成为事实标准

morewe

2016-11-08 18:59:35 +08:00

自己写了个。

jininij

2016-11-08 19:01:29 +08:00 via Android

dokuwiki 。无数据库，插件丰富，语法简单完整。

yubang

2016-11-08 20:43:15 +08:00

自己造一个轮子，能看就好

66beta

2016-11-09 10:19:23 +08:00

@Marser 有 wiki 功能的，一步到位

Marser

2016-11-09 10:53:10 +08:00

@66beta 好的，谢谢~~