我目前拿到的 api 文档大部分都是 word
This topic created in 3841 days ago, the information mentioned may be changed or developed.
 |
silencewwtMay 3, 2016
1
Sphinx, 然后生成 `read the docs` 风格的 html
|
 |
ewBuyVmLZMZEMay 3, 2016
2
是时候安利 swagger 了
|
 |
Victor215May 3, 2016 via Android
3
我们用 markdown
|
 |
crysislinuxMay 3, 2016
4
raml ， execl 也比 word 要好吧，其实我觉得 execl 也还可以。。。
|
 |
lecherMay 3, 2016 via Android
5
偷懒的时候直接写个接口专门扫文件，然后输出注释就显示，这样给前端一个 Web 接口就可以看所有注释了。
好处是只需要维护一份文档，方便实时更新，把注释写好就行，坏处太多列不完，文档不规范，没有格式等等一堆工程化要求没有达到 |
 |
6
我最近用了一个牛逼的东西，然后报价可以多报个一两千，这就是逼格的价值。
用 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 |
5 |
pepsinMay 3, 2016
7
Paw 改改 JS 生成的也不错
|
 |
odirusMay 3, 2016
8
表示强烈关注
|
 |
9
推荐 miredot,个人觉得比 swaggeer 好用。
|
 |
gucheenMay 3, 2016
12
swagger 和 markdown 搭配
|
 |
13
1 ，做过接口扫描+接口注释输出。
优点是只用维护一份文档； 缺点是页面比较简单，不好定制； 2 ，现在使用的 pelican+某个主题 优点是生成快，不用管文档结构，只写文档； 缺点是主题不好找，不好作内部链接引用。 想尝试用 sphinx+read the doc ，但是 rst 的复杂写法让我望而却步了。 |
 |
tadtungMay 3, 2016
14
gitbook 好些吧，，虽然之前我自己也写过，，，不过还是多用 gitbook
|
 |
roysMay 3, 2016
15
swagger ＋ 1
|
 |
rainysiaMay 3, 2016
16
swagger + 1
|
 |
ferstarMay 3, 2016
17
mark 下, 表示准备用 swagger
|
 |
kenshinhuMay 3, 2016
18
因为主要用 node,所以用 apidoc 来生成文档
|
 |
cookitMay 3, 2016
19
confluence wiki
|
 |
OceanzMay 3, 2016
20
https://github.com/thx/RAP 感觉还可以。
|
 |
hjxxMay 10, 2016
21
swagger 自动生成了
|
Select Language