The NSX Advanced Load Balancer includes support for the OpenAPI Specification or the Swagger RESTful API Documentation Specification.
The specification can be accessed through the Avi API Documentation link in the drop-down menu, as shown in the following screenshot.
Swagger UI Integration into the Controller
The Swagger UI is fully integrated into the NSX Advanced Load Balancer Controller. Admins can search from a list of API specifications through the search bar, as shown below.
Once a resource is selected, the location of the specification file is shown on the top, to the right of the Select API drop-down menu. This permits one to download the specifications from the NSX Advanced Load Balancer Controller and thereafter use them with swagger tools like the following:
Swagger Editor
Interactive tool for developing and viewing Swagger specifications.
Swagger Codegen
Generates Client SDKs in several languages.
Try it out Feature
Swagger UI also has a built-in Try it out functionality to try the API right from the context of the API documentation. The feature requires basic authentication setting to be enabled on the NSX Advanced Load Balancer Controller.
The output provides the following information.
Allowed query and body parameters
Equivalent curl command for the API
API response from the Controller
The following shows example of fetching all the pools through try it out.
