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 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.
Claims23
A system for securing, managing, and extending functionalities of Application Programming Interfaces (APIs) in a microservices architecture, the system comprising:
- a plurality of APIs organized into a microservices application architecture;
- a processor operated control plane communicatively coupled to the plurality of APIs via data plane proxies, wherein the control plane is configured to:
- receive an incoming proxied request from a first API of the plurality of APIs directed to a second API of the plurality of APIs, the proxied request relayed to the control plane via a first data plane proxy associated with the first API;
- receive a proxied response from the second API, the proxied response relayed to the control plane via a second data plane proxy associated with the second API;
- parse the proxied request and the proxied response and extract current data;
- in response to a transaction that includes the request and the response, execute an auto-documentation plugin, wherein the auto-documentation plugin is configured to generate documentation based on the current data;
- and
- a data store configured to store the control plane and the documentation.
A system comprising:
- a processor operated node architecturally positioned to receive proxied communications between a plurality of application program interfaces (APIs) that operate a microservices application, wherein the node parses API requests and responses in between the plurality of APIs 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 microservices application, the memory including a program code library configured to execute functionalities common to execution of the plurality of APIs on the node in communication with the memory.
A method for securing, managing, and extending functionalities of a plurality of Application Programming Interfaces (APIs) in a microservices architecture, the method comprising:
- receiving, by a control plane, an incoming proxied request from a first API of the plurality of APIs directed to a second API of the plurality of APIs, the proxied request relayed to the control plane via a first data plane proxy associated with the first API;
- receiving, by the control plane, a proxied response from the second API, the proxied response relayed to the control plane via a second data plane proxy associated with the second API;
- parsing the proxied request and the proxied response and extracting current data;
- and
- in response to a transaction that includes the request and the response, executing an auto-documentation plugin, wherein the auto-documentation plugin is configured to generate documentation based on the current data between the first API and the second API.
Dependencies are inferred from the claim text.