Документирование и тестирование HTTP API с помощью Sphinx

Написав веб-сервис, бывает неплохо его задокументировать: описать, какие ресурсы доступны, какие запросы они принимают и какой ответ от них ожидать в том или ином случае. И желательно с примерами, чтобы можно было наглядно представить, о чём речь. Но как быть уверенным, что примеры останутся актуальными завтра, через неделю, со следующим релизом?

Я расскажу о документировании HTTP API с помощью Sphinx и о том, как мы разрабатывали модуль для автоматизации тестирования HTTP-запросов и ответов, приведённых в документации.