получить вывод epydoc из вывода во время выполнения? - PullRequest
Новая
       0

получить вывод epydoc из вывода во время выполнения?

0 голосов
/ 30 декабря 2011

Я пытаюсь создать самодокументируемый веб-сервис python.

Моя ситуация:

У меня есть объект, доступный через веб-сервис RESTful python.

http://foo.com/api/monkey

И что я хотел бы сделать, это , если

  1. есть ошибкаво время звонка на http://foo.com/api/monkey как http://foo.com/api/monkey/get был вызван без "& monkey_id = {некоторый номер}"*или же*
  2. вызов веб-службы выполняется специально для http://foo.com/api/monkey/help

, а затем я хочу, чтобы он возвращал отформатированный HTML-вывод epydoc для этого объекта (динамически).

Я просмотрел Карниз , но это боль, потому что я не хочу использовать Пирамиду.Я действительно не хочу быть связанным с какой-либо конкретной веб-структурой, чтобы иметь возможность сделать это.

У меня такой вопрос: возможно ли то, что я хочу сделать с помощью epydoc?

1 Ответ

1 голос
/ 30 декабря 2011

Первый вариант использования («есть ошибка во время вызова») плохо определен.Например, 404 ошибки не приводят к страницам справки, они совершенно обычные.

Запрос http://foo.com/api/bad/path/get не может определить, какую страницу справки отправить, так как он не отправил запрос monkey.

Кроме того, /get на вашем путина самом деле не очень приятно.Выполнение /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 или любым другим веб-сервером) для перенаправленияк статическим файлам HTML, созданным Epydoc.

...