Registration from Swagger / OpenAPI documents

In the Add Service Wizard select Swagger from URL or Swagger from File option. These options are similar to WSDL from URL and WSDL from File(s) for SOAP services described in the Managing SOAP Services chapter, except that for REST services metadata documents are expected in the Swagger or OpenAPI v3 format. Sentinet supports both JSON and YAML format of the Swagger documents. For example, provide https://petstore.swagger.io/v2/swagger.json URL to the Swagger document that describes a popular public API:

Figure. Add Service Wizard with Swagger from URL option selected.

Click Next button to proceed with the registration process. On the review screen keep Add service in Active state checked if you would like to register service and its first service version in Active state, otherwise service version will be registered in the Draft state. You can also rename the service before it is registered in the Sentinet Repository.

Figure. Add Service Wizard and review screen.

Click Finish button to let Sentinet register REST API from its Swagger document. Once registration is complete, service version will be selected in the Repository tree.

Figure. Service and service version registered from the Swagger document.

Note

Services and service versions registered from the Swagger document can be further configured or reconfigured manually, just as if they were registered manually in the first place.