Exporting Specifications
For a REST API, you can export specifications in Swagger and RAML formats to your local system. Similarly, for a SOAP API, you can export a specification in WSDL format to your local system. The exported WSDL is in a ZIP format consisting of the WSDL file whereas for Swagger and RAML the respective files are directly exported. API Gateway supports the following versions:
Swagger 2.0 for a Swagger file
RAML 0.8 for a RAML file
You can export APIs that have been created from scratch or by importing their respective definitions. The Swagger or RAML definition provides the consumer view on a REST API deployed to the API Gateway. Similarly, the WSDL definition provides the consumer view on a SOAP API. Consumer view indicates that the Swagger, RAML, or WSDL definitions contain the API Gateway endpoint and information about those resources and operations, which are exposed to customers.
Note: In the downloaded Swagger document, the valid JSON schemas attached to a response or a request does not always appear. Only the valid JSON schemas appear correctly. For any other schema information just the generic JSON schema such as {"type":"object"} appears.
To export the specification
1. Click APIs in the title navigation bar.
2. Select the required API from the list of available APIs .
The API details page for the selected API appears.
3. Click Specifications.
4. Based on the type of specification that you have selected to export, select any of the following:
Swagger data link to export the Swagger specification.
RAML data link to export the RAML specification.
Artifacts link to export the WSDL specification.
OData meta document link to a zip containing the OData API and metadata document. If the OData API is active, a link to the service document and a link to the metadata document are also displayed.
When downloading a zip file the browser prompts you to either open or save the zip file.
5. Select the appropriate option and click OK.