请教各位写接口文档时,用的 wiki 系统是什么?公司自己开发的?还是使用的开源系统? 有没有开源的 wiki 系统推荐?最好是 php 开发的, node 的也接受~
![]() | 1 66beta 2016-11-08 16:53:10 +08:00 什么? PHP ? Phabricator |
![]() | 2 bugsnail 2016-11-08 16:58:47 +08:00 apidoc 就是注释写的有点麻烦 |
4 xfspace 2016-11-08 17:08:52 +08:00 via Android 自己做一个... Markdown ,用 Elasticsearch 做搜索。 |
![]() | 7 glasslion 2016-11-08 18:52:11 +08:00 1. 文档不应和代码分离。 放在外部 wiki ,容易忘记维护 。 2. wiki 语法太复杂。一般说明性的文档用 markdown 就足够了, 用 gitlab, Phabricator 查看起来很方便 3. REST API 接口 用 swagger , 这已成为事实标准 |
8 morewe 2016-11-08 18:59:35 +08:00 自己写了个。 |
![]() | 9 jininij 2016-11-08 19:01:29 +08:00 via Android dokuwiki 。无数据库,插件丰富,语法简单完整。 |
10 yubang 2016-11-08 20:43:15 +08:00 自己造一个轮子,能看就好 |