Use API Discovery Service

You can specify a URL pointing to a Swagger 2.0 or OpenAPI 3.0 definition. This feature enables synchronization with the specified definition.

api designer api sync

Prerequisites

  • You have a JSON file that serves as an API specification in the Swagger format.

Procedure

In this example, we will use the https://petstore.swagger.io/v2/swagger.json which is a sample pet store server.

  1. Create a new API.

  2. Set the type as External.

    Ensure that you set the API format in accordance with the format supported by your API server.

  3. Add a Name.

  4. Add the endpoint. In this case, it is https://petstore.swagger.io.

  5. Select Save and Display.

    Once that is done, select Edit. The API Discovery Service will appear.

  6. In API URI place https://petstore.swagger.io/v2/swagger.json.

  7. Select Synchronize.

A dialog will appear, presenting all the new operations along with their respective details. By selecting a specific operation, you will be able to view and compare all the details, effectively highlighting the changes between the old and new definitions.

api designer api sync diff

Select Synchronize to incorporate the new definition.

Result

api designer api sync result