用于记录API的Wiki软件

时间:2010-12-02 02:27:34

标签: web-services api documentation wiki soa

记录和共享API(例如HTTP网络服务)的可取方法是什么?

要求是:

  • 任何人都可以编辑任何页面的Wiki类型系统。
  • 编写API规范的简便方法,以便自动应用样式/格式,而不必手动为每个页面添加样式。

我会使用Wordpress,但它不是真正的Wiki系统;它更像是一个博客引擎。我想要一个漂亮,干净,结构化的页面层次结构,并且能够立即点击和编辑

我尝试了Google Sites,但这似乎也不合适,因为它不允许我为API创建一致的样式。我对造型的唯一控制是“主题”,它改变了外观和风格。对整个网站的感觉,并不够具体。

我找到了hosted solution here,但每年499美元,我相信我们可以做得更好。

有什么建议吗?

3 个答案:

答案 0 :(得分:2)

许多项目使用trac。以下是使用它http://djangobb.org/wiki

的项目示例

Trac将wiki,问题跟踪和源代码控制集成在一起。

答案 1 :(得分:0)

可能会考虑使用像doxygen之类的东西来生成初始快照,然后再进行wikify。

答案 2 :(得分:0)

此处也发布了类似的问题:Wiki solution for APIs documentations?

我建议使用MindTouch

**乔纳森,刚刚看到你对trac的评论增加了太多的复杂性。您可能会发现与MindTouch相同,但这是因为您要求解决特定问题,并且可用的合适工具提供更多功能(即复杂性)