Azure APIM request&response body description

Han Shih 施學翰 146 Reputation points

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

like this,operation%20may%20have%20other%20parameters%20%28path%2C%20query%2C%20header%29.

and this

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.

Azure API Management
Azure API Management
An Azure service that provides a hybrid, multi-cloud management platform for APIs.
1,818 questions
0 comments No comments
{count} votes

3 answers

Sort by: Most helpful
  1. MughundhanRaveendran-MSFT 12,446 Reputation points

    @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

    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.

    0 comments No comments

  2. Han Shih 施學翰 146 Reputation points


    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?

    0 comments No comments

  3. Han Shih 施學翰 146 Reputation points

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


    0 comments No comments