![]() | 1 silencewwt 2016-05-03 01:18:15 +08:00 Sphinx, 然后生成 `read the docs` 风格的 html |
![]() | 2 ewBuyVmLZMZE 2016-05-03 01:44:34 +08:00 是时候安利 swagger 了 |
![]() | 3 Victor215 2016-05-03 07:55:53 +08:00 via Android 我们用 markdown |
![]() | 4 crysislinux 2016-05-03 08:33:10 +08:00 raml , execl 也比 word 要好吧,其实我觉得 execl 也还可以。。。 |
5 lecher 2016-05-03 08:48:57 +08:00 via Android 偷懒的时候直接写个接口专门扫文件,然后输出注释就显示,这样给前端一个 Web 接口就可以看所有注释了。 好处是只需要维护一份文档,方便实时更新,把注释写好就行,坏处太多列不完,文档不规范,没有格式等等一堆工程化要求没有达到 |
![]() | 6 yellowV2ex 2016-05-03 09:01:33 +08:00 ![]() 我最近用了一个牛逼的东西,然后报价可以多报个一两千,这就是逼格的价值。 用 aglio 生成文档 https://github.com/danielgtaylor/aglio ,原始格式是基于 markdown 的 API Blueprint https://apiblueprint.org/ 生出来的东西大概是这样子的: http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/default.html 以及三列版 http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/default-triple.html |
![]() | 7 pepsin 2016-05-03 09:32:12 +08:00 Paw 改改 JS 生成的也不错 |
![]() | 8 odirus 2016-05-03 09:35:54 +08:00 表示强烈关注 |
![]() | 9 fwrq41251 2016-05-03 09:46:28 +08:00 ![]() 推荐 miredot,个人觉得比 swaggeer 好用。 |
11 chinajik 2016-05-03 09:50:15 +08:00 |
![]() | 12 gucheen 2016-05-03 09:56:41 +08:00 swagger 和 markdown 搭配 |
13 Drifter 2016-05-03 10:02:34 +08:00 ![]() 1 ,做过接口扫描+接口注释输出。 优点是只用维护一份文档; 缺点是页面比较简单,不好定制; 2 ,现在使用的 pelican+某个主题 优点是生成快,不用管文档结构,只写文档; 缺点是主题不好找,不好作内部链接引用。 想尝试用 sphinx+read the doc ,但是 rst 的复杂写法让我望而却步了。 |
![]() | 14 tadtung 2016-05-03 11:36:49 +08:00 gitbook 好些吧,,虽然之前我自己也写过,,,不过还是多用 gitbook |
![]() | 15 roys 2016-05-03 11:41:10 +08:00 swagger + 1 |
![]() | 16 rainysia 2016-05-03 12:01:03 +08:00 swagger + 1 |
![]() | 17 ferstar 2016-05-03 15:03:23 +08:00 mark 下, 表示准备用 swagger |
![]() | 18 kenshinhu 2016-05-03 15:11:39 +08:00 因为主要用 node,所以用 apidoc 来生成文档 |
19 cookit 2016-05-03 15:49:22 +08:00 confluence wiki |
20 Oceanz 2016-05-03 17:07:42 +08:00 https://github.com/thx/RAP 感觉还可以。 |
![]() | 21 hjxx 2016-05-10 10:06:18 +08:00 swagger 自动生成了 |