Import Swagger file programatically to Azure APIM

Question

Import Swagger file programatically to Azure APIM

Sujith 26

I am trying to deploy some services to APIM, I am trying to use the APIM "Management API" .
However I couldn't find a way to import the swagger file to the APIM using these Management APIs.
Any suggestions?

Accepted answer

1 additional answer

Your answer

Answer 1

Sam Cogan 10,812 Microsoft Employee Volunteer Moderator

You need to use the Create/Update API to pass in the URL of your swagger file. You can find an example here

Sujith 26 Reputation points

2022-01-11T12:45:19.667+00:00

Ok so this accepts the url of the swagger file, is there a way to use the swagger file as json text and import?
MayankBargali-MSFT 70,936 Reputation points Moderator

2022-01-11T12:54:34.047+00:00

@Sujith Unfortunately, API only accepts it as the swagger file while importing the swagger file as documented in the request body. You can try uploading your swagger file to your storage account or any path which is publically accessible.
Sujith 26 Reputation points

2022-01-11T13:06:15.147+00:00

Thank you

Answer 2

Sujith 26

There is a way to pass the swagger as json text.
Posting it here , so that it could be helpful for any others.
Call the APIM management API to create API and pass the below in body.

{
"properties": {
"format": "openapi+json",
"value": "<<swaggr json text goes here>>",
"path": "/"
}
}

Please note that format should be "openapi+json" for open api version 3.1 and "swagger-json" for open api version 2.

Share via

Import Swagger file programatically to Azure APIM

1 additional answer

Your answer