Creating REST APIs from scratch
To create a REST API from scratch
1. From the Integration Cloud navigation bar, click Projects > <Select a Project> > REST APIs.
The REST APIs page appears.
2. From the REST APIs page, click Add New REST API, select Build from scratch, and then click OK.
3. Complete the following fields and click Save.
The new REST API appears in the REST APIs page.
In this field... | Specify... |
Save As | Type a name for the REST resource using any combination of letters, numbers, and/or underscore characters. |
Swagger Title | Provide a title for the REST API. |
Description | Type an optional description for the REST API. |
Version | A version number. The value is typically 1.0. You need to change the version number if you want to modify and republish the REST API. |
Consumes | Select the MIME types that the API consumes. |
Produces | Select the MIME types that the API produces. The MIME types you select here will be part of the Swagger definition and will appear in the Responses section of the Swagger editor. While executing the REST API, you can choose the format in which you want to view the response. You must specify an Accept header in the REST client, else the default response will conform to the Content Type text/html. |
4. Click Save.
The REST API is created and appears in the REST APIs page. When you create a REST API, Integration Cloud uses the general information that you supplied to populate the Overview page in the REST API. You can click Edit to change the information in the Overview page. The name cannot be modified.
5. In the Resources page, click Add New Resource to add a Resource to the REST API. Type a Path, select a Mapped Integration that you want to invoke with this path, and select the HTTP Methods that can be used to invoke this Integration with this path. You can also provide a description for each method in the Operation Summary field. You can add more Resource Operations, if needed.
6. Click Save and Continue to add parameters and responses and then click Save and Finish. See Modifying Resource Operations for information on how to modify a REST Resource Operation. 7. To run an Integration with a certain path and method, go to the REST APIs page, select a REST API, and click the REST API link. The REST API details page appears.
8. Go to the Swagger page from the REST API details page. Click Authorize and type your Integration Cloud user name and password to authorize access to your APIs. Select the path and method pair and click Try it out. If required, pass the parameters and click Execute.
Responses will be displayed on the pane.