Automatic API Exposure via SOAP XML Generation
Find Innovative SolutionsGenerate Solutions
Solution Overview
Problem
Software developers face a time-consuming process in black box testing as they need to create client code for each specific software interface, requiring a need for automating the exposure of application programming interfaces (APIs) to client devices.
Innovation Solution
A system and method for automatically retrieving API signatures, parameters, and response parameters from an application server, generating SOAP XML messages, and providing them to client devices, allowing for the automatic exposure and invocation of APIs without manual configuration.
Engineering Contradictions & Design Principles
Engineering Contradiction Analysis
1Reliability
If software developers manually create client code for each software interface to perform black box testing, then testing can be conducted, but the process becomes time-consuming and labor-intensive
Solution Approach 1:
The system enables self-service by allowing the application server to automatically generate and expose API signatures and client code without requiring manual intervention from developers. The server retrieves its own API metadata, generates WSDL documents, and makes them available to client devices automatically.
Solution Approach 2:
The application server performs preliminary actions by pre-generating API signatures, parameter information, and response parameter data before testing is needed. This preliminary preparation eliminates the need for developers to create client code during the testing process.
2Reliability
If developers create client simulators for each interface, then black box testing can be performed, but the complexity of the development process increases
Solution Approach 1:
The system implements universality by using a standardized WSDL document format that can represent any API interface. Instead of creating unique client simulators for each interface, a single universal WSDL generation mechanism handles all interfaces, reducing complexity.
Solution Approach 2:
The WSDL document serves as an intermediary between the application server and client devices. It mediates the interaction by providing a standardized description of API interfaces, eliminating the need for complex custom client code for each interface.
3Ease of operation
If manual configuration is used to expose APIs to client devices, then interface calling is possible, but the process requires significant configuration effort
Solution Approach 1:
The application server performs self-service by automatically retrieving its own API signatures, parameter information, and response parameter data. This eliminates the need for manual configuration of API exposure settings.
Solution Approach 2:
The system performs preliminary actions by pre-generating complete WSDL documents that include all necessary API interface descriptions, parameter definitions, and response structures. This preliminary generation eliminates configuration time during deployment.
Data Source
AI summary
A system, method, and computer program product are provided for automatically exposing application programming interfaces (APIs) associated with an application server to one or more client devices. In use, at least one API signature corresponding to at least one API is retrieved from at least one application server. Additionally, first information associated with one or more parameters corresponding to each of the at least one API signatures is retrieved from the at least one application server. Further, second information associated with one or more response parameters corresponding to each of the at least one API signatures is retrieved from the at least one application server. In addition, at least one Simple Object Access Protocol (SOAP) Extensible Markup Language (XML) message is automatically generated, including the at least one API signature, the first information associated with the one or more parameters, and the second information associated with the one or more response parameters. Furthermore, the SOAP XML message is provided to a client device.