webapi_swagger_documentation
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | Next revisionBoth sides next revision | ||
webapi_swagger_documentation [2018/07/06 09:46 (6 years ago)] – kevin | webapi_swagger_documentation [2018/07/12 09:49 (6 years ago)] – Update to add info for swagger publishing through a browser gking_windwardsoftware.com | ||
---|---|---|---|
Line 58: | Line 58: | ||
- The list of available methods are now listed on the right side of the screen. | - The list of available methods are now listed on the right side of the screen. | ||
{{: | {{: | ||
+ | |||
+ | |||
+ | ==== Interacting With The Swagger 2.0 Documentation Via A Browser ==== | ||
+ | - As of Beta 6.2.7, The Swagger 2.0 documentation can be viewed and interacted with through a browser. | ||
+ | - Using a set of options in the S5WebAPISvc.ini file, the configuration of the Swagger publishing can be set and changed. | ||
+ | - {{: | ||
+ | - Once the S5WebAPISvc.ini options have been set, and the WebAPI service is running, open a web browser and enter localhost: | ||
+ | - Where PORT is the port under the Swagger Publishing options in S5WebAPISvc.ini | ||
+ | - After entering the WebAPI credentials and clicking the ' | ||
+ | - On this page, edit the contents of the search/ | ||
+ | - PORT is the port that the WebAPI is listening on (specified in S5WebAPISvc.ini, | ||
+ | - ENDPOINT is any one of the endpoints of the WebAPI. | ||
+ | - After clicking on the ' | ||
+ | - Once authorized the Swagger 2.0 documentation and WebAPI service can be interacted with. | ||
+ | - By clicking on an API method, the page will show more information for the method. | ||
+ | - Clicking the 'Try It Out' button allows users to enter parameters, and run the method. | ||
+ | - Clicking the ' | ||
webapi_swagger_documentation.txt · Last modified: 2022/02/23 13:40 (2 years ago) by kevin