Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Validating JSON messages against Swagger definition in Java

I created a REST API using a Swagger definition, now I need to validate incoming messages using that swagger schema. I found several solutions however all of them rely on some specific use case. The closest to what I need is this and true to it's description it works well with provided json schema, however when I deliver much more complex swagger definition, it just marks everything as valid. My question is. Is there any better, more complete or competent solution, library perhaps, that would natively validate given JSON messages against Swagger definition? I need this because I'm implementing WSO2 API REST solution and this would greatly help.

like image 695
Lone Wanderer Avatar asked Oct 20 '25 13:10

Lone Wanderer


2 Answers

Have a look at my answer here with a solution for this:

Validating json payload against swagger file - json-schema-validator

It's based on using the library: https://github.com/bjansen/swagger-schema-validator. It allows to check your json against the definitions contained in the swagger schema.

try (InputStream inputStream = schemaLocation.getInputStream()) {
            SwaggerValidator validator = SwaggerValidator.forJsonSchema(new InputStreamReader(inputStream));
            ProcessingReport report = validator.validate(message, "/definitions/Pet");
            return report.isSuccess();
        } catch (IOException e) {
            logger.error("IOException", e);
            return false;
        } catch (ProcessingException e) {
            e.printStackTrace();
            return false;
        }
like image 103
codependent Avatar answered Oct 22 '25 03:10

codependent


There is the swagger-request-validator having several adapters for various frameworks, e.g.: Spring Web MVC

It is capable of validating requests and / or responses against Swagger / OpenAPI 2 or OpenAPI 3 schemes.

It doesn't simply validate the defined JSON body. It validates the rest of the request, too, like path (variables), headers, etc.

The validator is capable of i18n.

Up until now the most complete validation against Swagger and OpenAPI in Java.

like image 34
Sven Döring Avatar answered Oct 22 '25 03:10

Sven Döring



Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!