Schema validation

[richardruiter]

Hi, we are implementing Contract Testing and have a need for validating the mocks we create against OpenApi and XML-RPC schemas from the backend teams. This makes sure we don't make false assumptions when using a mock server.

We already have a homegrown mockserver with this principle baked in, but we need more functionality and camouflage covers it.
First I was thinking to create middleware that can be shared with multiple teams and created a successful PoC with middleware.js

However then the idea arose to make schema validation part of camouflage server.

loglevel: info
protocols:
  http:
    enable: true
    mocks_dir: "./mocks"
    port: 8080
validation:
  schemas:
    - https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json
    - https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/example2.json

In the case of OpenApi It would parse the schemas with @apidevtools/swagger-parser, validate the request with openapi-request-validator and response with openapi-response-validator (I have the code for this already).

What do you think about the idea and config proposal?

[shubhendumadhukar]

It does seem an interesting feature to have. Since you already have the code for this, I would be happy to accept a PR. However, I do have a question. Can we control which request should be validated? Or is the validation carried out against all incoming requests?

[richardruiter]

The validation will only be done on the paths found in one of the schemas. For example when you configure https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json only /pets and /pets/{petId} will be validated. The rest will go as normal.

[shubhendumadhukar]

Sounds good. If you can submit a PR, I'll merge it to main.

[richardruiter]

I will work on this week..