KB Article #181773

update RAML API definition to supported format

Problem

  • How do I convert my old RAML APIs to a supported format?
  • As of 7.7.Jan2020, support for the RAML api definition format has been removed.
  • From release notes "RESTful API Modeling Language (RAML) support has been removed in favour of widely-adopted standards like Swagger and OpenAPI 3"

Resolution

Before upgrading to 7.7.Jan2020 or later, all RAML based APIs should be removed from API Manager.

If such an API is still needed, then it must be updated to a newer format and re-virtualized in API Manager.


  • Seek an updated API definition (Swagger 2.0 or OAS 3) from the the maintainer of the endpoint.
  • Conversion tools exist, such as:

https://github.com/esh-b/RAML-to-Swagger-Converter,

  • Or, before removing the RAML APIs from API Manager, download RAML APIs as Swagger from the API Catalog page.

Then import and virtualize that converted Swagger APIs as needed. Some modification may be needed, since the base path and host may reflect the old API Manager location, and not the original target host.