feat(docs): add validation docs #4874
Conversation
| calling a service to check if an address is valid. You can also create global, | ||
| class-level or method-level interceptors. | ||
|
|
||
| You can create interceptors using the |
There was a problem hiding this comment.
Just a tiny nitpick: You can create interceptors using the.. -> Interceptors can be created by... as we have ' You can also create global...' above.
dhmlau
requested review from
bajtos,
deepakrkris,
emonddr,
hacksparrow,
jannyHou,
nabdelgadir and
raymondfeng
as code owners
docs/site/Validation-ORM-layer.md
Outdated
| The validation in the ORM layer is to make sure the data being added or updated | ||
| to the database is valid. | ||
|
|
||
| There is validation coming from the legacy juggler. The validation is enforced |
There was a problem hiding this comment.
Perhaps provide a link to legacy juggler?
There was a problem hiding this comment.
There is validation coming from the legacy juggler
There is some validation done in legacy juggler.
There was a problem hiding this comment.
The validation is enforced at the database level, there is not much additional constraints we can set
beyond the database ones
The validation is enforced at the database level, so there aren't many additional constraints we can set
beyond the database ones.
There was a problem hiding this comment.
We can mention schema constraints enforced by specific DBs, such as unique index.
For preprocessing against CRUD operations, we can refer to https://loopback.io/doc/en/lb4/migration-models-operation-hooks.html.
| ## Add validation function in the Controller method | ||
|
|
||
| The simplest way is to apply the validation function in the controller method, | ||
| that is: |
There was a problem hiding this comment.
maybe like this?
The simplest way is to apply the validation function in the controller method.
For example:
|
@strongloop/loopback-maintainers, regarding the discussion around adding an example repo for validation, I have my app in https://github.com/dhmlau/loopback4-validation-example. Any objection to create another example in loopback-next? I don't mind either way, just don't know if it worths a separate example for that. Thanks! |
|
@dhmlau Maybe we can add some information about using 3rd party validation libraries, such as: |
dhmlau
force-pushed
the
validation2
branch
2 times, most recently
from
dfc5d08
to
5820df2
Compare
|
@raymondfeng @emonddr @agnes512 @achrinza, I've updated the PR based on the changes in the |
docs/site/Validation.md
Outdated
| Let's take a closer look at how validation can be added in the following layers: | ||
|
|
||
| - [REST layer](Validation-REST-layer.md) | ||
| - [Controller layer](Validation-controller-layer.md) |
There was a problem hiding this comment.
maybe have the description consistent with the url and title?
Validation in the Controller, Repository and Service Layer
There was a problem hiding this comment.
What would be your suggested change?
If I understand your comment correctly, since the sentence before the bullets are “… look at how validation can be added in the following layers:“, so it won’t make sense to make the bullet:
from REST layer to validation in REST layer.
There was a problem hiding this comment.
oh let me clarify, I meant using "Controller, Repository and Service layer"
dhmlau
force-pushed
the
validation2
branch
2 times, most recently
from
8429463
to
dc7ed3b
Compare
Add more documentation on how to add validation to a LoopBack application.
Propose to add the validation docs under "Usage scenarios"
Checklist
👉 Read and sign the CLA (Contributor License Agreement) 👈
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated👉 Check out how to submit a PR 👈