Auto-documentation for application program interfaces based on network requests and responses
AssigneeKong Inc.
InventorsMarco Palladino, Augusto Marietti
Life of this patent
Estimating the term…
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 online 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.
Claims30
A system for securing, managing, and extending functionalities of Application Programming Interfaces (APIs), the system comprising:
- a plurality of APIs;
- a plurality of plugins;
- one or more processor operated gateway nodes communicatively coupled to the plurality of APIs, wherein the one or more gateway nodes are configured to:
- receive an incoming request related to an API in the plurality of APIs,
- proxy the incoming request to the API in the plurality of APIs;
- receive a response from the API;
- parse the request and the response for extracting current data;
- execute an auto-documentation plugin in the plurality of plugins, wherein the auto-documentation plugin is configured to generate auto-documentation in response to a transaction that includes the request and the response, the auto-documentation based on the transaction;
- and
- a data store coupled to the one or more gateway nodes configured to store the plurality of plugins, wherein data in the data store is shared by each of the one or more gateway nodes.
A system comprising:
- a processor operated proxy server architecturally positioned between an application server and a client of the application server, the application server operating an application program interface (API), wherein the proxy server parses API requests from the client and the response from the API server and extracts current data and executes an auto-documentation program function, wherein the auto-documentation program function is configured to generate auto-documentation in response to a transaction that includes the request and the response, the auto-documentation based on the transaction;
- and
- a memory architecturally separate from the application server, the memory including a program code library configured to execute a program function used for operation of the API, wherein client requests of the API to execute the program function execute on the proxy server in communication with the memory.
A method comprising:
- receiving, by a first server, an application program interface (API) request from a client, the first server architecturally positioned between an application server for the API and the client of the application server;
- executing, on the first server, a program function from a program code library stored on a data store of the first server, the program function used for operation of the API;
- parsing, by the first server API requests from the client and the response from the API server extracting current data;
- and
- executing, by the first server, an auto-documentation program function, wherein the auto-documentation program function is configured to generate auto-documentation in response to a transaction that includes the request and the response, the auto-documentation based on the transaction.
Dependencies are inferred from the claim text.