実行時に出力からepydoc出力を取得していますか？

Question

私は自己文書化Python Webサービスを作成しようとしています。

私の状況：

私は、RESTfulなPythonのWebサービス経由でアクセス可能なオブジェクトを持っています。エラーがHTTPのようなhttp://foo.com/api/monkeyの呼び出し中にあります

1. 場合、私がやりたいものを

   http://foo.com/api/monkey

   とは、あります：//foo.com/api/monkey/getは "＆monkey_id = {いくつかの数}"
   
   *又は*
   
   

01なしで呼び出されました
2. Webサービスの呼び出しは、私はそれがそのオブジェクト（動的）のためのHTML形式epydoc出力を返すようにしたい

その後、をhttp://foo.com/api/monkey/helpするspecifcally行われます。

私はcorniceを見直しましたが、ピラミッドを使用したくないので痛みがあります。私は実際にこれを行うためには、特定のWebフレームワークに結合したくありません。

私の質問はこれです：私がしたいことは、epydocで可能ですか？

Answer 1

最初の使用例（「通話中にエラーがあります」）の定義が不適切です。 404エラーは、例えば、ヘルプページにはならない、彼らは完全に普通です。

http://foo.com/api/bad/path/getmonkeyリクエストを送信していないため、送信するヘルプページをリクエストできません。

また、/getをあなたのパスに入れても、まったくRESTfulではありません。 /monkey/get/monkey_id={some number}を行うことは悪い形とみなされます。 /monkey/{some mnumber}/を実行することを検討する必要があります。これはRESTfulと考えられています。

ヘルプを表示したい状況は非常に少なくあります。

ただし、ヘルプを表示したい場合は、エラー処理の種類がいくつかある可能性があります。 これには、他のエラーページの代わりにhttp://foo.com/api/monkey/helpに301リダイレクトを提供する必要があります。

普通のhttp://foo.com/api/monkey/help URLは静的なEpydoc製のHTMLファイルにリダイレクトするために、Apache（またはnginxやlighttpdなど、あなたのWebサーバが何であれ）が扱う必要があります。