webapi_swagger_documentation
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
webapi_swagger_documentation [2017/08/09 10:05 (7 years ago)] – drogall | webapi_swagger_documentation [2018/09/20 11:35 (6 years ago)] – [Getting The Swagger 2.0 Documentation Into editor2.swagger.io] jdayanan | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Windward Web API Swagger Documentation Usage ====== | + | ====== Windward Web API Swagger |
+ | ===== Summary ===== | ||
+ | Our Web API solution runs as a service and provides a doorway to push and pull information from a System Five database. | ||
+ | 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> | ||
- | ===== Summary | + | ===== Endpoints |
- | The following is an explanation for retrieving and using the Swagger | + | As of the 6.2.7 Beta there are multiple endpoints available for the Windward |
+ | - APBill | ||
+ | - Category | ||
+ | - Customer | ||
+ | - Inventory | ||
+ | - Invoice | ||
+ | - Keyword | ||
+ | - Units | ||
+ | - Vendors | ||
+ | - VirtualInventory | ||
+ | - TServerMethodsWebAPI | ||
- | *PREREQUISITE* You must have the Web API installed and running properly | + | All of these endpoints can be accessed with either of the following URLs: |
+ | | ||
+ | | ||
- | ====== Retrieve the Documentation ====== | + | ==== Deprecated Methods |
- | - The Swagger documentation is retrieved using a method | + | As of the 6.2.7 Beta the following |
- | - http:// | + | - Customers_Insert |
- | - Save the contents of the response, which is the Swagger documentation | + | - Customer_Read |
- | - Use your preferred Swagger editor (we suggest [[http:// | + | - 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 | ||
- | ===== Example Using Postman ===== | + | Replacement methods for these newly deprecated methods can be found within the other endpoints. |
- | - Open Postman | + | ===== Known Limitations ===== |
- | - Set the request type to GET | + | |
- | - Enter the URL, substituting the webapi_ip_address and webapi_port placeholders with the appropriate information for your Web API installation: | + | |
- | - Set the authorization type to Basic and enter your Web API credentials | + | |
- | - Send the request | + | |
- | - Copy the complete text in the Response area and save it as a text file | + | |
- | ====== Example using editor2.swagger.io ====== | + | 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. |
+ | Due to the JSON parser that the Windward Web API uses, any ' | ||
+ | |||
+ | ===== Retrieving The Documentation ===== | ||
+ | |||
+ | The Swagger documentation for a particular endpoint can be retrieved by using a method of the endpoint. | ||
+ | * http:// | ||
+ | * http:// | ||
+ | |||
+ | The contents of the response from the calls is the Swagger 2.0 documentation, | ||
+ | |||
+ | After configuring your S5WebAPISvc.ini, | ||
+ | |||
+ | ==== Getting The Swagger 2.0 Documentation Using Postman ==== | ||
+ | |||
+ | - Open Postman. | ||
+ | - Set the request type to GET. | ||
+ | - Enter one of the URLs, substituting the API_IP_ADDRESS, | ||
+ | * http:// | ||
+ | * http:// | ||
+ | - Set the authorization type to Basic and enter your Web API credentials. | ||
+ | - Send the request. | ||
+ | - Copy the complete text in the Response area and save it as a text file. | ||
+ | |||
+ | ==== 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 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 ' | + | - Click on the ' |
- | - Click on 'Paste JSON' | + | - Click on 'Paste JSON'. |
- | - Paste in the Swagger | + | - In the Swagger |
- | - Click on ' | + | - Click on ' |
- | - The list of available methods | + | - The list of available methods |
+ | {{: | ||
+ | |||
+ | |||
+ | ==== 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