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

2016-11-08 16:47:09 +08:00
 Marser

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

7604 次点击
所在节点    Wikipedia
12 条回复
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
自己做一个...
Markdown ，用 Elasticsearch 做搜索。
Marser
2016-11-08 17:28:53 +08:00
@xfspace 好 6
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
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 好的，谢谢~~

这是一个专为移动设备优化的页面（即为了让你能够在 Google 搜索结果里秒开这个页面），如果你希望参与 V2EX 社区的讨论，你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/319027

V2EX 是创意工作者们的社区，是一个分享自己正在做的有趣事物、交流想法，可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX