Layer7 API Management

  • Private Community

  • 1.  Swagger mark-downs

    Posted May 16, 2018 05:36 PM

    Does the API Developer Portal (EE) support mark-downs (https://swagger.io/docs/specification/2-0/basic-structure/) in Swagger?

     

    The mark-downs show up correctly in swagger editor, but get mangled in the API Developer Portal (see attached screenshots).

     

    Another thing to note is that if you go to the API Explorer page, the API doc content does not show up in the API Explorer, but the title of the API does.  Petstore example works fine, which leads me to believe it is not related to my setup.

     

    Thanks,

    Liem



  • 2.  Re: Swagger mark-downs

    Posted May 17, 2018 12:12 AM

    We are rolling Portal 4.2 now.

     

    CA support team confirmed MD is not supported now. MD support does not show in roadmap either.

     

    MD is part of OpenAPI 2.0 actually....



  • 3.  Re: Swagger mark-downs

    Posted May 17, 2018 06:22 PM

    It would be great to have support for MD in the near future...  Without it, it is probably usable for only very simple API docs.



  • 4.  Re: Swagger mark-downs
    Best Answer

    Posted Jun 05, 2018 10:35 PM

    Liem

    Please help by voting on this idea : API Portal to support MarkDown or GFM (or GitHub Flavored Markdown) 

    guy