AUTO-DOCUMENTATION FOR APPLICATION PROGRAM INTERFACES BASED ON NETWORK REQUESTS AND RESPONSES
First Claim
1. A method comprising:
- receiving, at a network node, one or more network packets containing an API request or API response associated with a first API;
proxying, by the network node, the API request or response;
parsing, by the network node, the API request or response;
determining, by the network node, a first behavioral indicator based on content of the API request or response as observed from said parsing;
determining, by the network node, that the first behavioral indicator is inconsistent with documentation for the first API based on a variance from a machine learning model; and
automatically updating, by the network node, the documentation for the first API based on the behavioral indicator.
2 Assignments
0 Petitions
Accused Products
Abstract
Disclosed embodiments are directed at systems, methods, and architecture for providing auto-documentation to APIs. The auto documentation plugin is architecturally placed between an API and a client thereof and parses API requests and responses in order to generate auto-documentation. In some embodiments, the auto-documentation plugin is used to update preexisting documentation after updates. In some embodiments, the auto-documentation plugin accesses an on-line documentation repository. In some embodiments, the auto-documentation plugin makes use of a machine learning model to determine how and which portions of an existing documentation file to update.
6 Citations
29 Claims
-
1. A method comprising:
-
receiving, at a network node, one or more network packets containing an API request or API response associated with a first API; proxying, by the network node, the API request or response; parsing, by the network node, the API request or response; determining, by the network node, a first behavioral indicator based on content of the API request or response as observed from said parsing; determining, by the network node, that the first behavioral indicator is inconsistent with documentation for the first API based on a variance from a machine learning model; and automatically updating, by the network node, the documentation for the first API based on the behavioral indicator. - View Dependent Claims (2, 4, 5, 6, 7, 8, 20, 21)
-
-
3. (canceled)
-
9. A method comprising:
-
receiving, at a gateway, an API request and an API response, wherein the API response corresponds to the API request, the API request and the API response associated with a first API; determining, by the gateway, parameters of the API request and values of the API response that correspond to the parameters; determining, by auto-documentation code, that any of the parameters or values are inconsistent with documentation for the first API based on a variance from a machine learning model; and automatically updating by the auto-documentation code, the documentation for the first API based on any of the parameters or values are inconsistent with documentation for the first API. - View Dependent Claims (10, 12, 13, 14, 15, 16)
-
-
11. (canceled)
-
17. A system comprising:
-
a network node within a network configured to receive one or more network packets containing an API request or API response associated with a first API, the network node further configured to proxy the API request or API response; and a memory containing auto-documentation code that when executed is configured to parse the API request or response and determine a first behavioral indicator based on content of the API request or response as parsed, and wherein the executed auto-documentation code is further configured to determine whether the parsed behavioral indicator is inconsistent with documentation for the first API based on a variance from a machine learning model within the memory, and when inconsistency is determined, automatically update the documentation for the first API based on the behavioral indicator. - View Dependent Claims (18, 22, 23, 24)
-
-
19. (canceled)
-
25. A method comprising:
-
receiving, by a server node, a client request from a client for an application server, wherein the server node is architecturally positioned between the application server and the client of the application server, the server node including auto-documentation code; transmitting, by the server node, the response of the application server to the client; parsing, by the server node, a transaction that includes the client request and the response; and generating, by the auto-documentation code, application documentation for the transaction based on the parsing of the transaction. - View Dependent Claims (26, 27, 28, 29)
-
Specification