接口管理

做接口管理的方案,目前有一下几种:

其中, api doc 是将 api 定义用注释的方式生成。其他都是文档管理的方式。是生成接口文档的一种工具。

又没有更好的思路呢?

目前,我能想到的思路是:

类似 api doc,在代码中添加注释的方式,定义接口文档,然后调用 generator 扫描项目目录,上报接口到管理平台,管理平台负责接口定义和文档管理。
即, 脚本上报接口定义, 平台负责前端展示。

问题:我想提前定义好接口方便对接方进行调试怎么办:

参考资料

https://www.ibm.com/developerworks/cn/opensource/os-sphinx-documentation/

«« 三十而立 使用 angularjs 中遇到的问题 »»