REST API Generation from Document Topic Hierarchies
Find Innovative SolutionsGenerate Solutions
Solution Overview
Problem
Current mechanisms lack the ability to efficiently retrieve and provide specific content from documents published online, requiring users to browse through extensive documentation and lacking updates notification, leading to increased search time and effort for consumers.
Innovation Solution
Deploying schematically enriched document content as Representational State Transfer (REST) APIs, where a computer generates REST APIs based on a parent-child topic hierarchy of a document's table of contents, allowing for the retrieval of specific content and managing document updates by converting verbs to nouns, repositioning and deleting repeated nouns, and deploying the REST resource model to client applications.
Engineering Contradictions & Design Principles
Engineering Contradiction Analysis
1Loss of information
If users browse through extensive documentation to find specific content, then complete document content is available, but search time and effort increase significantly
Solution Approach 1:
The patent segments the document into a hierarchical structure of topics and subtopics, allowing users to access specific portions rather than browsing the entire document. The table of contents is transformed into a structured framework where each topic represents a selectable unit, enabling direct navigation to desired content areas and eliminating the need to search through extensive documentation.
Solution Approach 2:
The patent introduces an intermediary layer between the document and the user - a REST API service that translates topic selections into document content retrieval. This intermediary handles the complexity of document navigation and content delivery, allowing users to access specific topics through standardized API calls without manually browsing or searching the document structure.
2Loss of information
If traditional document delivery is used, then all content is available to users, but network bandwidth and system resources are wasted transferring unnecessary content
Solution Approach 1:
The patent extracts only the specific topic content that users request, rather than delivering the entire document. The REST API enables selective retrieval where the server identifies and transfers only the relevant portions of the document based on the user's topic selection, eliminating the waste of network bandwidth and system resources associated with transferring complete documents when only specific sections are needed.
3Loss of information
If extensive documentation is provided, then comprehensive information is available, but user effort and complexity to navigate increase
Solution Approach 1:
The patent creates a universal interface (REST API) that can handle multiple document topics and formats through a consistent mechanism. The same API endpoints and request structures work across different topics and document types, providing a multi-functional access method that simplifies navigation regardless of the specific document content or hierarchy, thereby reducing user effort while maintaining information completeness.
Data Source
AI summary
Deploying schematically enriched document content as Representational State Transfer (REST) Application Programming Interfaces (APIs) is provided. Nouns corresponding to topics in a parent-child topic hierarchy of a table of contents of a document are utilized to generate a REST API for each topic in the parent-child topic hierarchy. A REST resource model is generated that contains each generated REST API corresponding to each topic in the parent-child topic hierarchy of the table of contents of the document. The REST resource model corresponding to the parent-child topic hierarchy of the table of contents of the document is deployed to subscribing client applications via a network.