在運行期間從輸出獲取epydoc輸出？

Question

我想創建一個自我記錄python web服務。

我的情況：

我已經得到了通過REST風格的蟒蛇Web服務訪問的對象。

http://foo.com/api/monkey

而且，我想要做的是什麼如果

1. 像HTTP來http://foo.com/api/monkey在通話過程中有錯誤：//foo.com/api/monkey/get被稱爲無 「＆monkey_id = {一些數}」
   
   *或*
   
   
2. Web服務調用比較特別作出http://foo.com/api/monkey/help

然後我希望它返回的HTML格式輸出epydoc的那個對象（動態）。

我已閱讀cornice，但它很痛苦，因爲我不想使用金字塔。我真的不希望被耦合到任何特定的Web框架能夠做到這一點。

我的問題是這樣的：我想用epydoc做什麼，可能嗎？

Answer 1

第一個用例（「通話過程中出現錯誤」）的定義不明確。例如，404錯誤不會導致幫助頁面，它們非常普通。

A http://foo.com/api/bad/path/get請求無法確定哪個幫助頁面發送，因爲它沒有發出monkey請求。

另外，把/get放在你的路上並不是真的很RESTful。做/monkey/get/monkey_id={some number}被認爲是不好的形式。你應該考慮做/monkey/{some mnumber}/。這被認爲是RESTful。

有很多很少的情況下你想要顯示幫助。

但是，可能會出現某些類型的錯誤處理，您希望顯示幫助。 對於這些，你應該提供301重定向到http://foo.com/api/monkey/help而不是其他一些錯誤頁面。

您的普通http://foo.com/api/monkey/help URL應由Apache（或nginx或lighttpd或任何您的Web服務器）處理以重定向到靜態Epydoc生成的HTML文件。