Swagger UI

Swagger UI is an interactive documentation tool for web APIs. It allows developers to visualize and interact with the API's resources without having any implementation logic in place. With the Babel Licensing Service, Swagger UI can be used to easily understand and test the API's functionalities. It presents the API endpoints, their required parameters, and lets you try out the API calls directly in the browser. This is particularly useful for testing, debugging, and understanding how to integrate with the Babel Licensing Service.

The Babel Service API facilitates resource management via four primary HTTP methods, each serving a distinct purpose within the Swagger UI interface:

  • GET: Retrieve data from the server. For instance, GET /v1/licenses would return a list of all licenses. This method is read-only and does not modify data.

  • POST: Create a new resource. Sending a POST request to /v1/products could create a new product entry. This method is typically used when submitting forms or uploading data.

  • PUT: Update an existing resource. Using PUT /v1/licenses/{licenseId} allows you to modify the details of a specific license. It's ideal for updating records when the entire object is being replaced.

  • DELETE: Remove a resource. For example, DELETE /v1/products/{productId} would delete the product with the specified ID. This method is used when you want to permanently delete a record.

Each method enables users to interact with the Babel Licensing Service efficiently, providing a comprehensive toolkit for integration and management of licensing operations through client applications.


To authenticate and access the Babel Licensing Service API through the Swagger UI, you need to click on the "Authorize" button located at the top right of the interface. A dialog should appear prompting you to enter your API key. You would enter the required information, such as your API key, in the designated field. An API key is automatically generated for the administrator user once the Babel Licensing Service is installed the first time.

Once the API key is entered, you'll confirm authorization which will allow you to execute API calls within Swagger UI.

Last updated