API Transformer Overview
You can convert API definition/specification files into any format of your choice from amongst more than 10 supported formats including OpenAPI, RAML and API Blueprint (complete list available in the later sections). This allows you to fully utilize all tools and functions that come with each format and saves the extra cost of having to rewrite your API definitions all over again.
Configure Transformer
The API goes through the following steps internally while you're only performing one step - transformation:
- API is imported.
- The imported API is validated.
- If the API passes validation, the API is converted/exported to desired format.
You can further customize how your file is imported or exported by using import/export settings that we provide e.g. you can disable auto-generation of test cases when importing your file or enable export of extensions and much more. Learn more about these customizations in our documentation on Configuring Transformer.
Moreover, APIMatic Transformer provides support for format-specific vendor extensions (e.g. for Swagger, RAML and API Blueprint) so you can configure our Code Generation engine from within your API specification file. For details, please refer to our detailed documentation on Extensions specific to your API definition file.
Refer to the lists below for detail on which versions and formats are supported for input and output of the Transformer:
Supported Input Formats
The API Transformer supports the following API specification formats as input and converts them into the selected output format:
| API Specification Format | Version | File Format |
|---|---|---|
| OpenAPI/Swagger | 3.1 3.0 2.0 1.x | JSON/YAML JSON/YAML JSON/YAML JSON |
| RAML | 1.0 0.8 | YAML YAML |
| Postman Collection | 2.0 1.0 | JSON JSON |
| Insomnia | 3 | JSON/YAML |
| HAR | 1.2 | JSON |
| API Blueprint | 1A | Markdown |
| WADL - W3C | 2009 | XML |
| WSDL - W3C | 1.1 | XML |
| Google Discovery | - | JSON |
| I/O Docs - Mashery | - | JSON |
| APIMATIC | - | JSON |
Supported Output Formats
The API Transformer supports conversion of the provided input API specification into the following formats:
| API Specification Format | Version | File Format |
|---|---|---|
| OpenAPI/Swagger | 3.1 3.0 2.0 1.2 | JSON/YAML JSON/YAML JSON/YAML JSON |
| RAML | 1.0 0.8 | YAML YAML |
| Postman Collection | 2.0 1.0 | JSON JSON |
| Insomnia | 3 | JSON/YAML |
| API Blueprint | 1A | Markdown |
| WSDL - W3C | 1.1 | XML |
| WADL - W3C | 2009 | XML |
| GraphQL Schema | - | GraphQL |
| APIMATIC | - | JSON |