大家都用什么写 api 文档？

This topic created in 4279 days ago, the information mentioned may be changed or developed.

列出所有api，每个api需要的参数列表、参数类型、是否必填、参数说明。
每个api的返回值。

参数

API

列出

21 replies • 2014-09-20 16:06:09 +08:00

lizhijun

Sep 19, 2014

markdown？

yibin001

Sep 19, 2014

@lizhijun
但是要用表格来写参数列表，比较头疼。。

linnchord

Sep 19, 2014

wiki by markdown

cnxh

Sep 19, 2014

haroopad

tolbkni

Sep 19, 2014

@yibin001 Markdown + GFM

jamiesun

Sep 19, 2014

不用sphinx吗

lululau

Sep 19, 2014

http://apiary.io

TangMonk

Sep 19, 2014

bitbucket 的 wiki

FuryBean

Sep 19, 2014

YuiDoc应该满足楼主的需求。YuiDoc实际上是不限制语言的，而且也不需要写到源码里面。

TangMonk

Sep 19, 2014

上次做的一个外包, 大家瞟下文档, 有没得啥子可提高的:

https://bitbucket.org/wuao/daxuebao-api/wiki/Home

davepkxxx

Sep 19, 2014

javadoc

yibin001

Sep 19, 2014

@lululau
这个不错。

yibin001

Sep 19, 2014

@lululau 语法也挺蛋疼的。。

lincanbin

Sep 19, 2014

markdown

konakona

Sep 19, 2014

哎...只能用excel、word写，用wiki除了我以外没人愿意维护，因为不愿意学wiki的写法...TAT

shiny

PRO

Sep 19, 2014

javadoc / phpdoc 这类语法,自动导出下就行了.

hehuozhao

Sep 19, 2014

https://readthedocs.org/

zeayes

Sep 19, 2014

trac wiki

Winny

Sep 19, 2014 via iPad

ASP.Net的Web api框架自动生成

xylophone21

Sep 19, 2014

这个要看语言吧，
c用doxygen
java用javadoc
JS只用NP API做过扩展，没找到太好的方案，现在感觉自定义注释+脚本+latex不错，不过没实施过。

总之，个人的感觉是接口文档不写在代码里就等于没写，根本没人看，同步也非常麻烦。

猿类都懒

pantaovay

Sep 20, 2014

markdown 使用 api blueprint生成很酷炫