用于记录 API 的 Wiki 软件 [已关闭]

Question

记录和共享 API（例如 HTTP Web 服务）的明智方法是什么？

要求是：

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

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

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

我在这里找到了托管解决方案，但每年 499 美元，我相信我们可以做得更好。

有什么建议吗？

Answer 1

许多项目使用trac。这是使用它的项目示例http://djangobb.org/wiki

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

Answer 2

可能会考虑使用 doxygen 之类的东西来生成初始快照，然后对其进行维基化。

Answer 3

这里也发布了类似的问题：API 文档的 Wiki 解决方案？

我建议使用MindTouch

**jonathan，刚刚看到您关于 trac 增加太多复杂性的评论。您可能会在 MindTouch 中发现同样的情况，但那是因为您正在寻求特定问题的解决方案，并且可用的合适工具提供了更多功能（即复杂性）