Automated API Documentation Verification via NLP Parsing
Find Innovative SolutionsGenerate Solutions
Solution Overview
Problem
Existing methods for verifying the accuracy of RESTful API documentation are time-consuming and inefficient, requiring manual test case design and harness creation to identify defects or inconsistencies in API functionality.
Innovation Solution
A computer-implemented method using natural language processing (NLP) to parse API documentation, identify endpoints, generate configurations and sample inputs, create test commands, execute these commands against the API, and validate outputs, thereby automating the validation process and generating tickets with results.
Engineering Contradictions & Design Principles
Engineering Contradiction Analysis
1Measurement precision
If manual test case design and harness creation are used to verify API documentation, then verification accuracy can be achieved, but the process becomes extremely time-consuming
Solution Approach 1:
The patent replaces manual mechanical testing processes with automated programmatic execution. Test engineers no longer manually design and execute test cases; instead, an automated system parses API documentation, generates test commands, executes them against the API, and validates outputs programmatically, maintaining verification accuracy while dramatically reducing time investment
Solution Approach 2:
The system enables self-service verification where the API documentation itself provides the test specifications. The automated system extracts endpoint information, parameters, and expected behaviors directly from the documentation, generates appropriate test commands, and executes validation without requiring external manual intervention or separate test case designs
2Reliability
If comprehensive testing is performed to gather sufficient evidence of API defects or inconsistencies, then verification reliability improves, but productivity decreases
Solution Approach 1:
The patent substitutes manual comprehensive testing with automated programmatic execution that can systematically cover all API endpoints and scenarios. The system programmatically generates and executes test commands for each endpoint, ensuring comprehensive coverage and reliable defect detection while increasing verification throughput through automation
Solution Approach 2:
The system performs preliminary parsing of API documentation to extract all endpoint definitions, parameters, and expected behaviors before execution. This preliminary action enables the automated generation of complete test command sets that comprehensively cover all API functionality, ensuring reliable verification while maintaining high productivity through pre-planned systematic testing
Data Source
AI summary
An approach for validating application programming interface (API) documentation. The approach parses documentation associated with an API using natural language processing (NLP). The approach identifies endpoints of the API in the documentation. The approach generates configurations based on parsing the documentation. The approach generates sample inputs based on identifying the endpoints of the API in the documentation. The approach generates test commands based on the sample inputs. The approach executes the test commands against the API. The approach validates output associated with the test commands. The approach generates tickets comprising results of the validating.