Create API from Open Proxy Specification file
- Matthias Senker (Deactivated)
- Mirco Hoffmann (Unlicensed)
Follow these instructions to create a new API by uploading an Open Proxy Specification file.
See OpenProxy Specification for details about the Open Proxy Specification format.
Navigate to “APIs“ in the menu on the left side.
Select “Create New API“ from the menu in the top right corner.
A dialog will open, that will guide you through the API creation process. Make sure to select “Create new API from specification files”. Use the Left “Choose“ button to select your Open Proxy Specification file. Optionally, you may also select an API Specification file (e.g. Open API) for documentation. If you omit the API Specification file here, you can always upload it later, after API creation has been completed.
Click the “Next” button to proceed. The Open Proxy Specification is now analyzed by API Control Plane and you will see the result of this analyis.
If any errors have been found, you will have to correct your Open Proxy Specification file. You can then click “Back“ and select the corrected file. Note: a common mistake is to upload the API Specification file instead of the Open Proxy Specification file. Please make sure you have selected the correct file.
If no errors have been found, click “Next” to proceed. If any warnings have been found, you should have a look at them, but you can still proceed to the next step.
Enter the details for the new API. The fields have been prepopulated with the values from you Open Proxy Specification file. You may choose to change some of these values here, e.g. provide a more detailed description or use a different display name. Keep in mind, though, that when you deploy your API into a gateway, the values from your Open Proxy Specification file will be used. See APIs for more info about API details.
The next step will inform you about the successful creation of the API. You can now choose to immediately deploy the API into one or more environments, by clicking “Next” or you can click “Skip” to finish the API Creation process at this point.
Select one or more environments to which you want to deploy the new API. Note that only environments that support Open Proxy Specification Deployment will be listed here (See Environment Capabilities)
In the final step, you will see which environments you have selected and you can choose which API version to deploy into these environments. Since you just created a new API with a single version, you only have one option here. Click “Deploy and Finish“ to start deploying the API and finish the API creation process.