Documentation

API documentation helps in understanding how to use APIs effectively. API description formats like the OpenAPI/Swagger Specification have automated the documentation process, making it easier for teams to generate and maintain them.

Refer to the API Documentation section under the API Products page.

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 Documentation section.

Fiorano uses OpenAPI Specification (OAS), for defining RESTful APIs. It uses an API console that developers can use to interact with the API and quickly learn the purpose of the API.

The figure below in Fiorano Developer Portal shows the query parameters for the GET method. For the PUT, POST, and DELETE methods, additional parameters such as the Form Params and the URL Encoded Params may also appear.

Test APIs using the Testing module

The testing module present under the Documentation section allows a developer to test the API with different sample requests and parameters to understand different invocation options and availability.

When we click the 'Try it out' button, we can examine the sample request and response. In the following figure, it takes two input query parameters 'From currency' and 'To currency'. After providing the required params and clicking the 'Try it out' button, a response is received which bears the results.

Documentation for Open API

Fiorano Developer portal supports both Swagger 3.0 (OpenAPI) and the older Swagger 2.0 versions.

With the help of Fiorano REST API Documentation, end users can quickly understand the value and usage of an API.

Thus, Documentation leads to good product maintenance. It helps internal teams know the details of resources, methods, and their associated requests and responses, making the maintenance of APIs and updating them quicker.