User Tools

Site Tools


webapi_swagger_documentation

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
webapi_swagger_documentation [2018/07/12 10:00]
gking_windwardsoftware.com
webapi_swagger_documentation [2018/11/14 16:14] (current)
kevin [Summary]
Line 5: Line 5:
  
 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 Web API.
- 
-<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 Web API. 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. 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.
Line 50: 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'.
webapi_swagger_documentation.1531414818.txt.gz · Last modified: 2018/07/12 10:00 by gking_windwardsoftware.com