docs: optimize egg-validate usage #2852
Merged
+2
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #2852 +/- ##
=======================================
Coverage 99.63% 99.63%
=======================================
Files 29 29
Lines 822 822
=======================================
Hits 819 819
Misses 3 3Continue to review full report at Codecov.
|
BaffinLee
reviewed
Jul 28, 2018
| @@ -156,7 +156,7 @@ class TopicController extends Controller { | |||
| const ctx = this.ctx; | |||
| // 校验 `ctx.request.body` 是否符合我们预期的格式 | |||
| // 如果参数校验未通过，将会抛出一个 status = 422 的异常 | |||
| ctx.validate(createRule); | |||
| ctx.validate(createRule, ctx.request.body); | |||
There was a problem hiding this comment.
第二个参数默认是 ctx.request.body，https://github.com/eggjs/egg-validate/blob/master/app/extend/context.js#L11
There was a problem hiding this comment.
您指出的默认参数值确实正确，不过我个人觉得似乎不太好查到。
我在查看 egg-validate 的 readme.md 的时候，并没有很直观的发现这条规则，以至于在写 get 请求获取 query 参数的时候，没有很快的解决这个需求点。
也可能是因为我是 node 菜鸟的缘故吧，不过我个人觉得文档更直观具体会更具友好性。如果您觉得我的建议确实不太具有建设性，我会关闭这个 PR 的。
再次对你的解答表示感谢啦 ：）
atian25
approved these changes
Jul 30, 2018
popomore
pushed a commit
that referenced
this pull request
Aug 6, 2018
docs: optimize egg-validate usage (#2852)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
npm testpassesAffected core subsystem(s)
Description of change
优化在文档 restful API 章节中， egg-validate 的使用，由原来的 ctx.validate(rule) 调整为 ctx.validate(rule, ctx.request.body)。
因为自己参照文档学习使用 egg 开发 cnode 范例的时候，不知道传第二个参数（即被检测的对象），踩了这个坑。。