From RIM
API projects can be created from RIM file(s) using From RIM option. RIM specification allows you defining REST APIs as per HATEOS principles.
For more information about RIM specification, refer to the link: https://github.com/temenostech/IRIS/wiki/introduction#overview
Adding the Project
Figure 1: Navigating to create a project using RIM file
Providing Basic Attributes
Provide values for the properties in the New API Project dialog box.
Figure 2: RIM Project properties
Property | Description |
|---|---|
| Display Name | A name to act as Project ID to identify the project. |
| Version | Revision number of the project. For example, 1.0 for a project being newly added and 1.1 or 2.0 for the next revision. |
| Proxy Context Path | This is a text used to combine with the version number to act as an identifier to map a particular deployed project. The proxy resolves context path mappings prior to applying any matching policies (explained in subsequent topics).
|
| Target Base Path | Target server URL where the app needs to use the service. |
| Load .rim/.zip | Click the Choose File button to browse and choose the RIM file or the ZIP file where RIM files are compressed. If the RIM files are part of the directory structure, they can be zipped retaining the folder structure and the zip file can be provided as an input. |
When a RIM file or ZIP containing RIM files is loaded, the different resources that are part of the RIM(s) provided are listed. API Author can choose the resources that needs to be part of the project being defined.
A resource is created in a project for each path - method combination that is selected.
After clicking the Next button, it is possible to perform API Customization and Product Mapping in the subsequent screens. Refer to the sections in the From REST or HTTP Service section.
Bulk API Customization
Whien importing, an option is provided to decide if the customization must be done at the project level or resource level. If project level is selected, the customization is applicable for all the resources in the project. If a fine-grained application of policies is required, it can be configured using the option 'Resource Level' where the customization can be different for different resources.
