Azure APIM request&response body description

Question

Is it possible to import request\response body description from swagger file?

like this
https://swagger.io/docs/specification/2-0/describing-request-body/#:~:text=The%20POST%2C%20PUT%20and%20PATCH%20requests%20can%20have,operation%20may%20have%20other%20parameters%20%28path%2C%20query%2C%20header%29.

and this
https://swagger.io/docs/specification/describing-responses/

It would be nice to show

• the format of request body
• the meaning of each field in request body"
• the format of response body
• the meaning of each field in response body"

If API consumers can understand

• the meaning of each field (not just the type)
• if the field is optional

It can make development more efficient.

Answer 1

@Han Shih 施學翰 ,

Thanks for reaching out to Q&A.

Formatting/describing the request and response body can be done from Swagger. Please refer the below articles

https://swagger.io/resources/articles/documenting-apis-with-swagger/

https://swagger.io/docs/specification/2-0/describing-request-body/

Swagger API can be imported to APIM via Open API specification

I hope this helps! Feel free to reach out to me if you have any queries or concerns.

Please 'Accept as answer' and ‘Upvote’ if it helped so that it can help others in the community looking for help on similar topics.

Answer 2

@MughundhanRaveendran-MSFT

Thanks for your reply. Let me make myself clear.

First, I export the sample yaml file from SwaggerEditor:

Second, I import that file into Azure APIM

Here are my questions:

• For POST request
  

If I want more detail about "how to write my POST request body", the only way is using "definitions", right?

• For GET request
  The same situation
  
  

To sum up, the detail information about any "structure object" should always be placed in "Definitions".
Am I right?

Answer 3

In addition, I want to know if "policies" in APIM (by API, operation, product) support import&export feature

Thanks!