Are there any CMS engines designed for creating reference documentation for a REST API? [closed]

烈酒焚心 提交于 2019-12-05 16:31:28
abraham

I/O Docs is an interactive documentation system running on nodejs. You generate a JSON schema of your API and it provides a HTML/JS site that describes your API and lets developers to play with it live from their browser.

Swagger is a specification for generating API docs and a framework for running your own documentation site.

While not a replacement for documentation Apigee ToGo would be a great addition to a more generic CMS for docs.

Sphinx isn't REST oriented but will generate documentation in general.

If you are building your API in Java Enunciate is something to look at as well. It will build documentation from JavaDocs.

Ryan Walls

Swagger has a "manual" way to enter your specs and generate documentation. See this answer here: https://stackoverflow.com/a/12085196/411229

Link to example project: https://github.com/wordnik/swagger-core/tree/master/samples/no-server

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!