How can we improve Azure API Management?

OpenAPI v3 support in Azure API Management

The OpenAPI Specification [https://github.com/OAI/OpenAPI-Specification] (formerly known as Swagger) defines a standard, programming language-agnostic interface description for REST APIs. Azure API Management currently supports OpenAPI versions 1.2 and 2.0. We are in the process of adding support for the recently released version 3 of the specification in both JSON and YAML formats. Our work is based on the OpenAPI.NET SDK [https://github.com/Microsoft/OpenAPI.NET] open source project.

486 votes
Vote
Sign in
Check!
(thinking…)
Reset
or sign in with
    Password icon
    Signed in as (Sign out)
    You have left! (?) (thinking…)
    AdminAzure API Management Team (Admin, Microsoft Azure) shared this idea  ·   ·  Flag idea as inappropriate…  ·  Admin →

    25 comments

    Sign in
    Check!
    (thinking…)
    Reset
    or sign in with
      Password icon
      Signed in as (Sign out)
      Submitting...
      • Everton Macedo commented  ·   ·  Flag as inappropriate

        OpenAPI3 JSON/YAML Definition seems to include azure-api.net hosts even if I have set-up a custom domain :/

      • Mastak commented  ·   ·  Flag as inappropriate

        Doesn't work properly ( works fine only if you need download specification ).. Easiest way to try it:
        1. go to Developer portal
        2. select one of existing API's
        3. download Open API 3 (YAML)
        4. edit downloaded specification and fix endpoint, name
        5. back to APIM
        6. press import API and select edited specification
        7. Error: Could not create an API. Please try again later.

        If you try Add new API and start with blank and put same YAML there you get "unexpected error".

      • Anthony Myhre commented  ·   ·  Flag as inappropriate

        We ran into an issue where we are using POST/PUT endpoints with no request body. The swagger for the app service does not have a request body in the endpoint definition (which is expected), but when we import the definition to the API Manager, the Open API 3 definition creates a request body with the content empty.

        "requestBody": {
        "content": {

        }
        }

        This is an issue because when our web team runs the code gen tool, it gets the following error

        Exception: Request body cannot be null. Possible cause: missing schema in body parameter (OAS v2): class RequestBody {
        description: null
        content: class Content {
        {}
        }
        required: null
        }

      • Antonio Fernandes commented  ·   ·  Flag as inappropriate

        In the Developer Portal, I'm getting as of today the following options for the APIs definitions:

        Open API 3 (YAML)
        Open API 3 (JSON)
        Open API 2 (JSON)
        WADL.

        That would be nice, if the Opn API 3 definitions didn't end just before the "definitions:" section:

        "x-ms-export-notes": [
        "The exported API contains schemas that aren't of content type 'application/vnd.oai.openapi.components+json', and are hence not exported as OpenAPI components."
        ]... :-(

      • Joel Roberts commented  ·   ·  Flag as inappropriate

        Hi, is there an updated ETA on OAS3 availability in Azure API Management? swagger-codegen support is now in 'experimental' for the aspnetcore server stubs, which will increase interest in the topic.

      • Richard commented  ·   ·  Flag as inappropriate

        Any update on this feature?

        OAS 3 supports syntax for OpenID and OID Connect Discovery, which would provide better compatibility with features provided Azure API management. Currently we're maintaining Swagger 2.0 and OAS 3 versions of our docs.

      • Anonymous commented  ·   ·  Flag as inappropriate

        Will this update enable support for the full range of parameter types allowed by OpenAPI? Currently when defining a parameter of type array APIM strips everything away and sets it to a simple string type. This is very frustrating and disappointing.

        https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameter-object

        https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object-examples

      • prem commented  ·   ·  Flag as inappropriate

        Status of this request was updated 6 months ago to "STARTED". So many people have asked for an ETA since then. Is any one in Azure actually care ? Or should we start looking for alternate options ?

      • Anonymous commented  ·   ·  Flag as inappropriate

        Looking forward to Open API3 support ASAP, please confirm ETA.

        Johny Baby
        Majesco Limited

      • Anonymous commented  ·   ·  Flag as inappropriate

        What is the ETA for Open API 3.0 Support?

        It is extremely important for our production usage of the Azure API Gateway

      • prem commented  ·   ·  Flag as inappropriate

        OpenAPI v3 is a must have as the spec was released more than an year ago. Can we please have an ETA.

      • Roger Solsvik commented  ·   ·  Flag as inappropriate

        Hi.
        Are there any information about when we can expect support for OpenAPI v3? Maybe somewhere we can follow your progress?

      • Tiago Barbosa commented  ·   ·  Flag as inappropriate

        Is there an ETA for this feature to be in production? This a blocker for some industry scenarios.

      ← Previous 1

      Feedback and Knowledge Base