Azure API Management - Can I define a custom response status code?

Question

When setting up the all the possible response codes and their descriptions for an endpoint in API Management Service, I can only choose an existing status code from a dropdown list, but it doesn't allow me to add a custom status code, such as 499. I use the 499 status code in my API for a specific type of error relevant to my applicatoin. Is there any way to add this to the list of responses?

Joey Cai · Accepted Answer · 2019-08-12 09:52:36Z

1

You could dynamic mocking using APIM with an APIM policy called return-response.

<return-response>
    <set-status code="200" reason="OK" />
    <set-header name="content-type" exists-action="override">
        <value>"application/json"</value>
    </set-header>
    <set-body>{
        "id": "cat12345",
        "name": "Garfield",
        "tag": "Sleepy Cat"
    }</set-body>
</return-response>

For more details, you could refer to this tutorial.

answered Aug 12, 2019 at 9:52

Joey Cai

20.2k1 gold badge25 silver badges34 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Costin_T Over a year ago

I don't want to mock it though, because I already have a fully functional API. I need to have it listed there so that it can appear in the API documentation portal.

Vitaliy Kurokhtin · Accepted Answer · 2019-08-19 17:32:12Z

0

Not with forms UI. But if you select an API, there'll be a pencil in Frontend block on Design tab. It allows you to edit your API specification in OpenAPI 2/3 spec. Using that it should be possible to add a custom response statuses code.

answered Aug 19, 2019 at 17:32

Vitaliy Kurokhtin

7,9601 gold badge22 silver badges19 bronze badges

Collectives™ on Stack Overflow

Azure API Management - Can I define a custom response status code?

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related