最近要整理公司的接口
有没有好的工具能够去编写这个文档
有没有人用过RAML
取决于你们公司使用的开发语言吧。
比如用的是Java,就用Javadoc;
用的是Javascript,就用jsdoc;
用的是Ruby,就用RDoc;
用的是Obj-c,就用appledoc;
等等。
当然最关键是,原来的接口相关的注释是否有恰当地编写
把接口的注释写得规范一点,再写个脚本解析自己的注释及结合代码,生成文档
可以了解一下Doxygen,它基于代码中特定格式的注释,可自动生成HTML(还有其它可选格式)的API文档。
支持多种语言,简单、易用,但前提是你的项目代码注释完备!
工具主页如下:
http://www.doxygen.nl/
具体内容自行参考官方说明。
用markdown吧
swagger是我用过最好用的,只是编写相关的json比较麻烦,又不想集成在代码中。不过可以在网站(www.sosoapi.com)上在线表单方式编写swagger-ui对应的json哈,编辑简单而且可以在线预览和导入导出,挺方便的
doxmate ,用markdown 编写文档