PayU / openapi-validator-middleware

Input validation using Swagger (Open API) and ajv
Apache License 2.0
144 stars 50 forks source link

1.0.0 #32

Open idanto opened 6 years ago

idanto commented 6 years ago

This we should do before 1.0.0:

@kibertoad feel free to add your thoughts

kibertoad commented 6 years ago

OpenAPI 3.0 sounds more like 2.0.0 stuff since it will likely require further componentization of the code and will require quite a bit of effort. Synchronous middleware loading is definitely nice, I'll look into this. How do you suggest to approach investigating for missing swagger features?

I would also suggest doing as ES6 pass over code to use things like let/const, arrow functions etc (given that we only support Node 6+). Also maybe integrating prettier would be a good idea.

idanto commented 6 years ago

I agree with you about the OpenAPI 3.0 and it will be great to do the alignment for ES6 syntax.

An approach to investigating missing swagger features is a good question. I would search around:

  1. Supported data types
  2. Validation for parameters
  3. Security Defenitions

I think those are the core features that related to input validation.

The approach in my opinion should be to start writing tests for each of the keywords and see the behavior, In case it is not as expected we can open an issue and fix it.

We also know that we miss support in multiple swagger file but that's a known issue that I don't think we should address now

kobik commented 5 years ago

i believe that everything described by you two so far, besides sync init shouldn't require a new major release.

i actually see it more like a roadmap.

kibertoad commented 5 years ago

I agree, it was more of a brainstorm regarding what this library needs to be feature-complete, rather than hard prereq.