请教各位写接口文档时,用的 wiki 系统是什么?公司自己开发的?还是使用的开源系统? 有没有开源的 wiki 系统推荐?最好是 php 开发的, node 的也接受~
请教各位写接口文档时,用的 wiki 系统是什么?公司自己开发的?还是使用的开源系统? 有没有开源的 wiki 系统推荐?最好是 php 开发的, node 的也接受~
|
66betaNov 8, 2016
1
什么? PHP ?
Phabricator |
|
bugsnailNov 8, 2016
2
apidoc
就是注释写的有点麻烦 |
|
xfspaceNov 8, 2016 via Android
4
自己做一个...
Markdown ,用 Elasticsearch 做搜索。 |
|
glasslionNov 8, 2016
7
1. 文档不应和代码分离。 放在外部 wiki ,容易忘记维护 。
2. wiki 语法太复杂。一般说明性的文档用 markdown 就足够了, 用 gitlab, Phabricator 查看起来很方便 3. REST API 接口 用 swagger , 这已成为事实标准 |
|
moreweNov 8, 2016
8
自己写了个。
|
|
jininijNov 8, 2016 via Android
9
dokuwiki 。无数据库,插件丰富,语法简单完整。
|
|
yubangNov 8, 2016
10
自己造一个轮子,能看就好
|