我正在创建一个 REST API,用于与我们正在构建的新 SaaS 网站连接,我们需要记录该 API,以供第三方 iOS 开发人员(以及服务公开后的其他开发人员)使用。是否有任何现有的数据库驱动的内容管理系统可以帮助为此类系统构建 API 文档?
我希望能提供比通用 wiki 或 WordPress 构建更定制的东西。
编辑:我可能应该提到我们的 VPS 设置为 LAMP 堆栈,因此 PHP 驱动的东西会更好。
自我记录不是必需的,我实际上想要更多手动的东西。我想使用 CMS 作为仍需要编写的 API 的设计平台。
I/O Docs https://github.com/mashery/iodocs是一个运行在nodejs上的交互式文档系统。您生成 API 的 JSON 模式,它提供一个 HTML/JS 站点来描述您的 API,并让开发人员可以通过浏览器实时使用它。
Swagger http://swagger.wordnik.com/是生成 API 文档的规范和运行您自己的文档站点的框架。
虽然不能替代文档Apigee ToGo http://apigee.com/about/products_togo.html将是对更通用的文档 CMS 的一个很好的补充。
Sphinx http://sphinx.pocoo.org/不是面向 REST 的,但通常会生成文档。
如果您正在使用 Java 构建 API阐明 http://enunciate.webcohesion.com/也是值得关注的事情。它将根据 JavaDocs 构建文档。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)