How to validate a JSON is in correct format in Azure APIM

Question

How to validate a JSON is in correct format in Azure APIM

Arun Kumar KS 41

How can I validate a JSON request body in APIM and return BadRequest if the JSON is not in correct format?

1 answer

Your answer

Answer 1

Sujithreddy Komma 581 Microsoft Employee

Hi Arun,

Can toy Please look into the Validate-Content Policy ? Here is the info

https://learn.microsoft.com/en-us/azure/api-management/validation-policies#schemas-for-content-validation

Let us know fi you need more details

Arun Kumar KS 41 Reputation points

2022-07-01T12:19:28.893+00:00

Hi Sujith,

Actually, we have dynamically generated requests coming to APIM from Salesforce and sometimes the JSON is coming as not in a valid format. Before calling the function app, we need to validate the incoming payload. Can I set an inbound policy for validating the JSON format?
Sujithreddy Komma 581 Reputation points Microsoft Employee

2022-07-01T12:25:07.423+00:00

Hi Arun,

Yes you need to set an inbound Policy for it.

Just wanted to know like you just need to validate whether its a right Json or it has to be validate against some json schema?
Validate Content Policy will help you for both the ones.
Arun Kumar KS 41 Reputation points

2022-07-01T12:27:25.75+00:00

Hi Sujith

For now, I just wanted to validate it's the right JSON format. If you have some references, it would be great.
Sujithreddy Komma 581 Reputation points Microsoft Employee

2022-07-04T06:29:45.323+00:00

Hi Arun,
Use the below Policy in your Inbound Section

<validate-content unspecified-content-type-action="prevent" max-size="102400" size-exceeded-action="prevent" errors-variable-name="requestBodyValidation">
<content type="application/json" validate-as="json" action="prevent" />
</validate-content>
Change the Size of the Json as you require it.

Since you require just to validate the Schema, go into your Operation and then go to Request Section and then create a Definition Like below

in the Definition you can define a Schema, no need to define any required fields as you only want to validate the Json Schema like below

Now try it will work.

To benefit the community find the right answers, please do mark the post which was helpful by clicking on ‘Accept Answer’ & ‘Up-Vote’.
Arun Kumar KS 41 Reputation points

2022-07-04T07:18:05.993+00:00

Hi Sujith,

Thanks for the detail reply.

I didn't find an option for Request in Operations. Please see the screenshot below:
Sujithreddy Komma 581 Reputation points Microsoft Employee

2022-07-04T07:21:06.293+00:00

Edit the Front End Section
Abha BARANWAL 0 Reputation points

2024-05-09T09:03:42.6533333+00:00

Hi Sujith,

The validate-content code provided validates for json and request body size. I also want to want to validate against existing definition which was imported via Opem API Spec.

I see validate-content also has schema-id and ref, but providing the definition name in schema-id doesn't seem to work.
Can you please suggest how to go about it.

Thanks.

Share via

How to validate a JSON is in correct format in Azure APIM

1 answer

Your answer