joi.example API是干什么用的？

Question

这个API是干啥用的阿？看不懂

Answer 1

这不写的很明白了么：

Adds an example. Note that no validation is performed on the value.

就是添加了一个示例值。

这里 Joi.string().min(4) 就是要求一个长度最少为 4 的字符串，"abcd" 就是一个示例值。

注意它这里强调了，这个示例值本身并不会被校验，所以你要是强行填一个错的示例也能编译通过、不会抛异常，就还比如这里你给的示例值要是 "abc" 也不会报错，但看的人就会懵逼了 —— 不是说好了长度最少为 4 么、怎么示例给了个 3？

---

你可能会觉得示例值写在注释里也行，为啥非得弄这么个函数出来。这个其实主要是为了配合 swagger 或者别的什么文档生成框架，最后生成出来的文档里会带着这个示例值。