什么是REST风格的API文档管理的最佳工具？ [英] What's the best tool to manage documentation for Restful API?

问题描述

我在构建ASP.NET一个RESTful API。我想用一个工具，将保留所有的功能和行动组织，便于编辑分组并可以导出各种格式（HTML，PDF）文档来记录其功能。

I'm building a RESTful API in ASP.NET. I'd like to document its features with a tool that will keep all the functionality and actions organized and grouped for easy editing and can export the documentation in various formats (HTML, PDF).

我的不的寻找一个自动生成脚本，它将分析我的code - 尤其是因为内部的方法和属性，将是API的最终用户大多是没有意义的

I'm not looking for an auto-generating script that will parse my code - especially since the internal methods and properties would be mostly meaningless for the end users of the API.

推荐答案

我只能在春天的REST框架，在这里你可以使用RESTdoclet评论。这是使用的doclet API来生成服务的基于Web的视图Maven插件，很象的JavaDoc一样。

I can only comment on the Spring REST framework, where you can use RESTdoclet. It is a Maven plugin that uses the doclet API to generate a web-based view of your services, much like JavaDoc does.

这篇关于什么是REST风格的API文档管理的最佳工具？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！