良好的示例/模板/最佳實踐API文檔

我爲Web服務創建前端，另一家公司爲後端。我需要一個好的，簡單易懂的方式來製作一個API調用文檔，我們可以一起協作和編輯，而不會相互混淆。良好的示例/模板/最佳實踐API文檔

是否有任何好的規格/示例等項目的API文檔，所以這不會在很多重寫寫入很大的混亂？

2011-09-07 longstaff

整個Python庫是項目API文檔的一個很好的例子。你似乎只是從這裏開始。 http://docs.python.org/library/。使用你已有的作爲例子有什麼問題？ –

爲了完整起見，我假定後端將用Python編寫。你使用的標籤表明這一點，但你不明確這麼說。 –

@MortenSiebuhr是的，這是真的，但我不認爲這很重要，因爲我不知道Python作爲一門語言，並且仍然需要爲API的功能作出貢獻。 – longstaff

我選擇的文檔：Sphinx。

其他：

但斯芬克斯是相當真棒。

2011-09-07 12:34:03 Tauquir

看起來很有趣，但是對於我來說Python的一面太重了，因爲我對python沒有影響，需要自己做出改變和建議。 – longstaff

@shortstick;你不需要做任何python編碼。只需安裝Sphinx，你只需要編寫標記。根本沒有python。 – Tauquir

獅身人面像似乎工作得很好，所以生病讓你受到打擊。謝謝！ – longstaff

對於小型API，我開始使用Google文檔。它的協作功能非常棒，您可以看到對此文檔所做的所有更改的列表。

2011-09-07 12:36:32

回答