API Products
Products Module provides ways for developers to search for different API products (bundles) based on product details such as description and tag. The developer can check different APIs bundled as part of the product and add them to the application created. Click the API Products tab in the Home Page to navigate to this module.
Product Details
To view the Product details along with the projects under the product, click the Product name present in the API Products module.
Figure 1: Products Module
This section gives out the Product details which are comprised of:
- Product Name
- Product Id
- Subscription Status
ID and name are the attributes attached to the product as they are in the API Management tool. The subscription status indicates whether or not the product has been subscribed by the client.
APIs
Multiple APIs would have been added to a product in the API Management tool. In the Developer Portal, the APIs are available in the API Products page.
It includes the following details:
- Product name
- Description
- API Project Id
- Version number
- Environment
Environment indicates the Server Group in which the project is deployed, for example, Development, Production etc.
Figure 2: Products Details with the list of API Projects present under the product
Testing the App
The testing module allows the developer to test the API with different sample requests and parameters to understand different invocation options and availability.
Prerequisite
Before starting the testing, Cross-Origin Resource Sharing (CORS) needs to be enabled in API Manager profile.
- Stop the API Management Server.
- Open Profile Manager perspective in eStudio and launch the APIManager profile.
- Navigate to Fiorano > APIManager > APIProject > Controller > APIProjectController.
- Enable the following properties under the ComponentInstanceConfiguration section:
- EnableCors: To enable cors globally for all API projects.
- HandlePreFlightRequest: To handle preflight request globally for all API projects.
- Restart API Management and API Gateway Servers.
Figure 3: Configuring the API Management profile
Testing
To test the app, switch to the Developer Portal and click the Environment name present in the API Products section under the Product Details page (see the Figure 2 above).
Detailed documentation of the API with complete information about the parameters involved, sample requests and responses, and authentication mechanisms used can be viewed in the API Documentation section.
This section comprises of the same fields as present in the Overview section within Fiorano API Management.
- Expand the Show/Hide or List Operations or Expand Operations properties to see the respective parameter details.
- The figure below shows parameters for the GET method. Methods such as PUT, POST and DELETE, additional parameters such as the Form Params and the URL Encoded Params can also be added in the API Management Overview section.
Figure 4: API Documentation section with the GET method parameters and the option for testing
Provide the parameter values, for examples FromCurrency = USD and ToCurrency = INR, and click the Try it out button to test the App.
Figure 5: The Documentation section showing the response to testing
A Fiorano API Management user can take control of all the applications created by the developer from the Developer Portal.
Hiding IP Address from the the Request URL in Swagger
If the IP address should not be shown in the Request URL in Swagger, specify the domain name in the Gateway Server profile.
To provide the domain name, perform the following actions:
- Stop the API Gateway Server.
- Open Profile Manager perspective in eStudio and launch the APIGateway profile.
- Navigate to Fiorano > APIGateway > Esb > Peer > Configuration > FPSCommonConfigLoader.
- Provide the domain name in the MappedPublicAddress section.
- Start the API Management Server.
Figure 6: Option to specify domain name for which the IP address should not be displayed