Как исключить тест из документации

Я работаю с Dredd, платформой тестирования HTTP API, чтобы протестировать API серверной части. Идея состоит в том, что каждый раз, когда вы создаете тестовый пример, документация будет генерироваться автоматически, что является хорошей практикой для обеспечения того, чтобы документация всегда была актуальной и управляемой тестами. Иногда мне нужно создать тестовый пример без создания соответствующей документации. Я хотел бы найти способ, как исключить тестовый пример из документации.

Спасибо !


person larnouch    schedule 19.11.2018    source источник


Ответы (1)


У вас может быть несколько документов с описанием API. Один будет ориентирован на пользователя, с документацией, а другой может быть с угловыми случаями, полезными только для тестирования. Dredd может принимать несколько документов с помощью параметра --path.

Еще одна вещь: вы можете составить документ из нескольких документов. Вы не упомянули, какой формат описания API вы используете, поэтому я не могу привести вам прямой пример. В случае API Blueprint вы можете использовать Hercule.

person Honza Javorek    schedule 25.03.2019