如何排除测试出现在文档中

How to exclude a test from appearing in the documentation

我正在使用 Dredd HTTP API 测试框架 来测试我的后端 API。 好的想法是,每次创建测试用例时,都会自动生成文档,这是确保文档始终是最新的和测试驱动的好习惯。 有时我想创建一个测试用例而不生成其相关文档。我想找到一种方法如何 排除 测试用例 出现在 文档 中。

谢谢!

您可以有多个 API 描述文档。一个将面向用户,带有文档,而另一个可以包含仅对测试有用的边角案例。 Dredd 可以使用 --path 选项接受多个文档。

另一件事是您可以将多个文档组合在一起。你没有提到你使用的是哪种 API 描述格式,所以我不能给你一个直接的例子。如果是 API Blueprint, you could use Hercule.