Managing REST APIs

In this tutorial, and for demonstration purposes only, we will use a sample Order Service REST API that comes with the Sample Services sample application shipped with the Sentinet installation package. This demo REST API will represent a backend (or a physical) REST API, that has to be placed under Sentinet management.

1. Start Customer Search sample service from Sample Services Windows shortcut or launch C:\Program Files\Nevatech\Sentinet\Samples\SampleServices\bin\Release\ Nevatech.Vsb.Samples.SampleServices.exe program using Run as administrator Windows option. Make sure Order Service radio button and REST radio button for the Service Kind are selected.

   

2. Click Start button and then View Help page link.

   A browser window opens with the browser HTML page that shows short documentation for the Order Service REST API.

   

   Note

   A help page shown above is just a user-friendly description of an API (you can drill down page links for more details about each API’s operation). Order Service sample REST API does not produce OpenAPI Specification (aka Swagger) document, which could have been used otherwise (if available) to register REST API in the Sentinet.