HTTP API Control Unit Unifies Request Response Structures
Find Innovative SolutionsGenerate Solutions
Solution Overview
Problem
Existing communication apparatuses face challenges in reducing the load of implementing remote control programs due to complex API specifications, particularly with different request and response body structures for each HTTP method, making it difficult for developers to understand and implement remote control functions efficiently.
Innovation Solution
A communication apparatus with a control unit that executes programs corresponding to received API requests and returns responses in a predetermined structure, using a combination of HTTP request methods, simplifying the implementation by maintaining consistent JSON syntax formats for request and response bodies across API categories.
Engineering Contradictions & Design Principles
Engineering Contradiction Analysis
1Adaptability or versatility
If API specifications are published with unique structures for each HTTP method, then the communication apparatus can support multiple APIs, but the load of understanding and implementing each API structure increases
Solution Approach 1:
The patent applies universality by publishing a single, unified API specification that can be used across multiple HTTP methods (GET, POST, PUT, DELETE). Instead of creating unique structures for each method, the same API specification serves multiple purposes and methods, reducing the complexity of understanding and implementation while maintaining broad adaptability.
2Ease of manufacture
If different request and response body structures are defined for each API, then specific API requirements can be met, but the programming load increases
Solution Approach 1:
The patent merges the request and response body structures into a unified format that can be used across different HTTP methods. By combining the specification into a single structure rather than maintaining separate structures for each method, the implementation becomes easier while development efficiency is maintained through the use of standard HTTP methods with consistent data formats.
3Ease of operation
If comprehensive API specifications are published, then remote control functionality is enabled, but the difficulty of understanding the specifications increases
Solution Approach 1:
The patent applies homogeneity by using consistent data structures and formats across all API specifications. The unified structure means that developers encounter the same format regardless of which API or HTTP method they are working with, making the specifications easier to understand while still providing comprehensive remote control functionality.
Data Source
AI summary
A communication apparatus includes a communication unit configured to communicate with an external apparatus based on Hypertext Transfer Protocol (HTTP), a recording medium configured to record programs corresponding to a plurality of application programming interfaces (APIs), and a control unit configured to control the communication unit to, when a request regarding any of the plurality of APIs is received, execute the program corresponding to the API regarding which the request is received, and return a response including a data set described in a predetermined structure to the request, wherein the control unit is configured to perform control to describe the data set in the same structure in a case where a request using a first HTTP request method regarding a predetermined API among the plurality of APIs is received and in a case where a request using a second HTTP request method regarding the predetermined API is received.