CODEWITHSUNDEEP
javajsonrestvalidationswagger
Lone Wanderer
Lone Wanderer

Reputation: 198

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.

Upvotes: 4

Views: 4579

Answers (2)

Sven Döring
Sven Döring

Reputation: 4368

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.

Upvotes: 2

codependent
codependent

Reputation: 24442

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;
        }

Upvotes: 3

Related Questions