OAS-Based API Proxy Generation to Reduce Manual Errors
Find Innovative SolutionsGenerate Solutions
Solution Overview
Problem
Existing API proxy generation processes are manual, error-prone, and lack standardization, leading to inefficiencies and increased development time, security vulnerabilities, and resource redundancy across enterprise departments.
Innovation Solution
An automated and repeatable process for generating API proxies using an open application programming interface (OAS) document to model computing resources and data elements, enabling the creation of standardized API proxies that reduce errors, enhance security, and conserve resources.
Engineering Contradictions & Design Principles
Engineering Contradiction Analysis
1Manufacturing precision
If manual API proxy generation is used, then flexibility in customization is maintained, but error rate increases and development time extends
Solution Approach 1:
The system performs self-service by automatically generating API proxies through computational processes that take OAS documents as input and produce standardized proxy code without manual intervention, thereby reducing errors while implementing automation
Solution Approach 2:
The patent replaces manual mechanical processes of API proxy creation with automated computational systems that process OAS documents and generate proxies algorithmically, substituting human effort with machine-based generation to reduce errors and improve consistency
2Loss of energy
If standardized API proxy generation is implemented, then resource redundancy is reduced, but adaptability to unique departmental needs may decrease
Solution Approach 1:
The system achieves universality by creating a standardized API proxy generation process that serves multiple enterprise departments through a common platform, reducing resource redundancy while maintaining the ability to handle different departmental requirements through configuration rather than custom development
Solution Approach 2:
The patent enables adaptability through parameter changes by allowing customization of API proxies via modifications to OAS document parameters and configuration settings, rather than requiring fundamental changes to the generation process itself, thus balancing standardization with departmental needs
3Loss of time
If automated API proxy generation is deployed, then development time is shortened, but complexity of the generation system increases
Solution Approach 1:
The patent introduces an intermediary OAS document as a standardized interface between the automated generation system and API proxy output, simplifying the overall system architecture by providing a clear contractual specification that mediates between input requirements and generated proxies
Data Source
AI summary
Techniques are described for generating an API proxy and backend implementation. An example method can include accessing computing resource modeling information and data element relationship modeling information. The method can further include generating an API outline comprising a field identifier and a field definition. The method can further include generating an OAS document comprising information for defining an application programming interface proxy. The method can further include accessing API proxy information from the open application programming interface specification document. The method can further include generating an API proxy based at least in part on the API proxy information, the API proxy operable for accessing information based at least in part on the field identifier or the field definition.