Как исключить тест из появившейся в документации

Question

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

Спасибо!

Answer 1

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

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