2011-12-29 55 views
0

我想创建一个自我记录python web服务。在运行期间从输出获取epydoc输出?

我的情况:

我已经得到了通过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做什么,可能吗?

+0

这种事情是在.NET> WCF中自动完成的。 – bitcycle 2011-12-29 22:05:59

回答

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文件。