Windward Software Wiki

User Tools

Site Tools

Trace:
webapi_swagger_documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
webapi_swagger_documentation [2018/07/06 09:46 (6 years ago)] – kevinwebapi_swagger_documentation [2019/01/30 12:05 (5 years ago)] – kevin
Line 2: Line 2:
  
 ===== Summary ===== ===== Summary =====
-Our Web API solution runs as a service and provides a doorway to push and pull information from a System Five database.  This technology will work with both onPrem installations and our System Five on Cloud deployments.  +Our s5webAPI solution runs as a service and provides a doorway to push and pull information from a System Five database.  This technology will work with both onPrem installations and our System Five on Cloud deployments.  
  
-The following is an explanation for retrieving and using the Swagger 2.0 documentation from all available endpoints of the Windward Web API. +The following is an explanation for retrieving and using the Swagger 2.0 documentation from all available endpoints of the Windward S5WebAPI.
- +
-<note important>You must have the Windward Web API installed and running properly before you are able to retrieve and use the Swagger 2.0 documentation.</note>+
  
 ===== Endpoints ===== ===== Endpoints =====
  
-There are multiple endpoints available for the Windward Web API each providing different functions for the Web API. These endpoints are the following:+As of the 6.2.2.175 there are multiple endpoints available for the Windward Web API each providing different functions for the S5WebAPI. These endpoints are the following:
   - APBill   - APBill
   - Category   - Category
Line 20: Line 18:
   - Vendors   - Vendors
   - VirtualInventory   - VirtualInventory
-  - TServerMethodsWebAPI (Most methods in this endpoint are deprecated)+  - TServerMethodsWebAPI
  
 All of these endpoints can be accessed with either of the following URLs: All of these endpoints can be accessed with either of the following URLs:
Line 26: Line 24:
   * http://API_IP_ADDRESS:API_PORT/datasnap/rest/ENDPOINT   * http://API_IP_ADDRESS:API_PORT/datasnap/rest/ENDPOINT
  
-===== Known limitations ===== +==== Deprecated Methods ==== 
-The 6.2.2 released versions of the Web API has a maximum limit of 32 concurrent connections. This limit has been removed in the 6.2.7 beta version and is now limited by how much available memory is on the server or workstation running the API.+ 
 +As of the 6.2.2.175 the following methods in the endpoint TServerMethodsWebAPI are deprecated.  They will continue to operate but with this any new software development should use these methods. 
 +  - Customers_Insert 
 +  - Customer_Read 
 +  - Customers_Update 
 +  - Get_Customers 
 +  - List_Customers 
 +  - Parts_Read 
 +  - Parts_Update 
 +  - Get_Parts 
 +  - List_Parts 
 +  - Insert_Parts 
 +  - Get_Main_Categories 
 +  - Get_Categories 
 +  - Suppliers_Insert 
 +  - Suppliers_Read 
 +  - Suppliers_Update 
 +  - Get_Suppliers 
 +  - List_Suppliers 
 +  - Invoices_Insert 
 +  - Invoices_Get 
 +  - Invoices_Update 
 +  - Invoices_Read 
 +  - Insert_Full_Invoice 
 +  - Insert_AP_Bill 
 + 
 +Replacement methods for these newly deprecated methods can be found within the other endpoints. 
 + 
 +===== Known Limitations ===== 
 + 
 +Prior to 6.2.2.175 released versions of the Web API has a maximum limit of 32 concurrent connections. This limit has been removed in the 6.2.2.175 and is now limited by how much available memory is on the server or workstation running the API. 
 + 
 +<note tip> 
 +Due to the JSON parser that the Windward Web API uses, any '%' characters inside of JSON strings will cause internal server errors. 
 +</note>
  
 ===== Retrieving The Documentation ===== ===== Retrieving The Documentation =====
Line 35: Line 67:
     * http://API_IP_ADDRESS:API_PORT/datasnap/rest/ENDPOINT/Swagger     * http://API_IP_ADDRESS:API_PORT/datasnap/rest/ENDPOINT/Swagger
  
-The contents of the response from the calls is the Swagger 2.0 documentation, after copying the response text and saving it into a text file use your preferred Swagger editor (we suggest [[http://editor2.swagger.io|editor2.swagger.io]]) to view the Swagger documentation.+The contents of the response from the calls is the Swagger 2.0 documentation, after copying the response text and saving it into a text file use your preferred Swagger editor (we suggest [[http://editor.swagger.io|editor.swagger.io]]) to view the Swagger documentation. 
 + 
 +After configuring your S5WebAPISvc.ini, you can view and interact with the Swagger 2.0 documentation and the Web API through a browser, without using Postman or a Swagger editor.
  
 ==== Getting The Swagger 2.0 Documentation Using Postman ==== ==== Getting The Swagger 2.0 Documentation Using Postman ====
Line 48: Line 82:
   - Copy the complete text in the Response area and save it as a text file.   - Copy the complete text in the Response area and save it as a text file.
  
-==== Getting The Swagger 2.0 Documentation Into editor2.swagger.io ====+==== Getting The Swagger 2.0 Documentation Into editor.swagger.io ====
   - Open the json file in a text editor and copy the contents to your clipboard   - Open the json file in a text editor and copy the contents to your clipboard
   - Open a web browser (Google Chrome, for example) and navigate to the following URL:   - Open a web browser (Google Chrome, for example) and navigate to the following URL:
-      * [[http://editor2.swagger.io|editor2.swagger.io]]+      * [[http://editor.swagger.io|editor.swagger.io]]
   - Click on the 'File' menu.   - Click on the 'File' menu.
   - Click on 'Paste JSON'.   - Click on 'Paste JSON'.
Line 58: Line 92:
   - The list of available methods are now listed on the right side of the screen.  Each method has two sections, a Parameters and a Response section, these sections outline the format for both the request parameters and the response.   - The list of available methods are now listed on the right side of the screen.  Each method has two sections, a Parameters and a Response section, these sections outline the format for both the request parameters and the response.
 {{:swagger_io_json.jpg?400|}} {{:swagger_io_json.jpg?400|}}
 +
 +
 +==== 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.
 +    - {{:undefined:swagger_ini_options.png?200|}} 
 +  - Once the S5WebAPISvc.ini options have been set, and the WebAPI service is running, open a web browser and enter localhost:PORT/index.html into the address bar
 +    - Where PORT is the port under the Swagger Publishing options in S5WebAPISvc.ini
 +  - After entering the WebAPI credentials and clicking the 'Submit' button, the swagger-ui page will be shown.
 +  - On this page, edit the contents of the search/explore bar. Changing the values for PORT, and ENDPOINT
 +    - PORT is the port that the WebAPI is listening on (specified in S5WebAPISvc.ini, under the HTTP/HTTPS option)
 +    - ENDPOINT is any one of the endpoints of the WebAPI.
 +  - After clicking on the 'Explore' button and waiting for the Swagger 2.0 documentation to load, click on the 'Authorize' button and reenter the WebAPI credentials, this must be done before being able to call any of the endpoint's methods.
 +  - 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 'Execute' button will send the method and it's parameters (if any) to the API, giving back the API's response. 
  
webapi_swagger_documentation.txt · Last modified: 2022/02/23 13:40 (2 years ago) by kevin