Swagger is an API documentation tool which exposes the API documentation on a web app. It shows the endpoints and their parameters and allows you to run requests as a client. It is a very useful tool when you need to simulate a third-party application making requests.
Since EAM endpoint is a soap web service it will not have the swagger documentation by default for on-premise version. Therefore, you should build custom swagger documentation for our EWSConnector externally and upload it to the ION API defined above so that the ION API will recognize the service and will be available as part of ION API Metadata.
The Swagger documentation for the EAM EWSConnector that we built is attached to this PDF in the Attachments pane. Open the file and change the host, which is the EAM service host name, and the basePath defined in the above ION API.
For Cloud versions we have the documentation already defined as part of "Infor Provisioned" Infor EAM® suite and the steps below are not required.
-
Upload the documentation to ION API.
-
After successfully uploading, you will find the swagger documentation as shown here.
-
When you click on the EWSConnector link you can try the sample testing using this documentation and check if you are getting the expected response for your EAM webservice request.
Request
Successful response
After sending the request to the endpoint, you will get a status code of "200" if the server response is successful. You can find the response in the Response body as shown here.
Error response
After sending the request to the endpoint, you will get a status code of "500" if the request fails. You can see the details of the failed response in the Response body as shown here.
