US 11,379,225 B1Granted

System and methods for application programming interface reference documentation updater

AssigneeWells Fargo Bank, N.A.

InventorsSaravanakumar Velusamy, Srilakshmi Mudigere, Ramesh N. Tejavath

Life of this patent

Estimating the term…

Loading patent…

Abstract

Systems, methods, and apparatuses for an application programming interface (API) definition automation system that is structured to programmatically generate API documentation in human-readable format. A control database is structured to retrievably store control documents. A content database is structured to retrievably store control document templates. A configuration file manager circuit is structured to generate an API configuration file in a data serialization language. An editor circuit structured to receive the API configuration file and a first control document that is human-readable. The editor circuit is also structured to generate a user interface that includes an API call executable structured to generate an API call field and a table editor executable structured to generate a parameter table. The editor circuit is also structured to apply a modification to the first control document. A content management system is structured to receive the first control document and generate an output document.

Claims20

Dependent claims

An application programming interface (API) definition automation system structured to programmatically generate API documentation in human-readable format, the system comprising:

a processing circuit including a processor and memory;
a network;
a control database structured to retrievably store control documents and communicatively coupled to the network;
a content database structured to retrievably store control document templates and communicatively coupled to the network;
a configuration file manager circuit communicatively coupled to the network, and structured to generate a API configuration file in a data serialization language, wherein the API configuration file is machine-readable;
an editor circuit communicatively coupled to the network, the editor circuit structured to:
receive the API configuration file;
receive a first control document, the first control document being human-readable and including the control documents and the control document templates;
generate a user interface, the user interface comprising:
an API call executable structured to automatically generate, based on the API configuration file, an API call field and automatically provide the API call field on the first control document;
and
a table editor executable structured to automatically generate, based on the API configuration file, a parameter table and automatically provide the parameter table on a parameter field of the API call field the API call field having a header and an interactive field that, when selected, opens a parameter field for parameters, and a response field for a caption and summary;
receive a user input fora modification to the first control document via the user interface;
apply the modification to the first control document based on the user input;
and
a content management hardware system structured to:
receive the first control document from the editor circuit;
and
generate an output document based on the control documents and the modification, the output document having a HyperText Markup Language (HTML) format.

16 more elements

A method of programmatically generating an application programming interface (API) document in human-readable format, the method comprising:

generating, by a configuration file manager circuit, an API configuration file in a data serialization language, the API configuration file is machine-readable;
receiving, by an editing circuit, the API configuration file and a control document, the control document being human-readable;
generating, by the editing circuit, a graphical user interface (GUI), the GUI including the control document;
automatically generating, by an API call executable of the GUI and based on the API configuration file, an API call field having a header box, a parameter box for parameters, and a response box for a caption and summary;
automatically positioning, by the editing circuit, the API call field on the control document;
automatically generating, by a table editor executable of the GUI and based on the API configuration file, a parameter table;
automatically positioning, by the editing circuit, the parameter table on the parameter box;
receiving, by the editing circuit, a user input including a modification to the control document;
applying, by the editing circuit, the modification to the control document;
receiving, by a content management system, the control document from the editing circuit;
and
generating, by the content management system, an output document based on the control document and the modification, the output document having a HyperText Markup Language (HTML) format.

9 more elements

A non-transitory computer readable medium having computer-executable instructions embodied therein that, when executed by at least one processor of a computing system, cause the computing system to perform operations to programmatically generate an application programming interface (API) documentation in human-readable format, the operations comprising:

receiving an API configuration file, the API configuration file in a data serialization language and a machine-readable format;
receiving a control document, the control document being human-readable;
generating a graphical user interface (GUI), the GUI including the control document;
automatically generating, by an API call executable of the GUI, based on the API configuration file, an API call field having a header and an interactive field that, when selected, opens a parameter field for parameters, and a response field for a caption and summary;
automatically modifying the control document with the API call field;
automatically generating, by a table editor of the GUI, a parameter table based on the API configuration file;
automatically modifying the parameter field with the parameter table;
receiving a user input for a modification to the control document via the GUI;
modifying the control document based on the user input;
and
generating based on the modified control document an output document having a HyperText Markup Language (HTML) format.

8 more elements

Dependencies are inferred from the claim text.