Guided definition of an application programming interface action for a workflow

• US 10,521,195 B1
• Filed: 03/19/2019
• Issued: 12/31/2019
• Est. Priority Date: 03/19/2019
• Status: Active Grant

• Current Assignee: ServiceNow Incorporated
• Original Assignee: ServiceNow Incorporated
• Inventors: Swope, Stuart Dean, Rodriguez, Natallia Rabtsevich, Maloy, Christopher, Dias, Rebecca Anita
• Primary Examiner(s): Khatri, Anil
• Application Number:
  US16/358,276
• Time in Patent Office: 287 Days
• Field of Search: 717102-116, 717120
• CPC Class Codes: G06F 16/9566 URL specific, e.g. using aliases, detecting broken or misspelled links
• CPC Class Codes: G06F 8/20 Software design
• CPC Class Codes: G06F 8/34 Graphical or visual programming
• CPC Class Codes: G06F 9/54 Interprogram communication
• CPC Class Codes: G06F 9/542 Event management; Broadcasting; Multicasting; Notifications
• CPC Class Codes: G06Q 10/0633 Workflow analysis

Abstract

A computing system includes persistent storage configured to store definitions of actions for integration into workflows, and a software application configured to define an action that invokes a function of an application programming interface (API). The software application obtains a specification and identifies therein definitions of a uniform resource locator (URL) that addresses the API, the function, an input of the function, and an output of the function. The software application generates an input variable of the action that corresponds to the input of the function and an output variable of the action that corresponds to the output of the function. The software application determines a first mapping between the input variable and a URL parameter of the API and a second mapping between the output variable and a response from the API. The first and second mappings are stored in in the persistent storage to define the action.

Claims

1. A computing system comprising:

persistent storage configured to store definitions of actions for integration into workflows;

one or more processors; and

an action design software application configured to define an action that invokes a function of an application programming interface (API), wherein the action design software application is configured to perform, by way of the one or more processors, operations comprising;

obtaining a specification that defines attributes of the API;

identifying, within the specification, definitions of (i) a uniform resource locator (URL) that addresses the API, (ii) the function, (iii) an input of the function, and (iv) an output of the function;

generating (i) an input variable of the action that corresponds to the input of the function and (ii) an output variable of the action that corresponds to the output of the function;

determining a first mapping between the input variable and a URL parameter of the API,

wherein execution of the action generates a modified version of the URL that includes therein a value of the input variable according to the first mapping and invokes the function by transmitting a request to the modified version of the URL during execution of a workflow;

determining a second mapping between the output variable and a response from the API, wherein the response is to the request, and

wherein reception from the API of the response causes a value of the output of the function to be stored in the output variable according to the second mapping during execution of the workflow; and

storing the first mapping and the second mapping in the persistent storage to define the action;

wherein the URL parameter of the API comprises at least one of (i) a URL resource path parameter that identifies a specific resource provided by a server device that hosts the API or (ii) a URL query parameter comprising a key and value pair.

2. The computing system of claim 1, wherein the action is a first action of a plurality of actions, and wherein the computing system further comprises:

a workflow design software application configured to define workflows that include one or more of the plurality of actions, wherein the workflow design software application is configured to perform, by way of the one or more processors, operations comprising;

receiving selection of the first action and a second action to define the workflow, wherein the second action precedes the first action in the workflow;

receiving an assignment of a second output variable of the second action to the input variable of the first action; and

generating a connection between (i) the second output variable and (ii) the input variable, wherein a value of the second output variable is passed from the second action to the input variable of the first action during execution of the workflow.

3. The computing system of claim 1, wherein the action is a first action of a plurality of actions, and wherein the computing system further comprises:

a workflow design software application configured to define workflows that include one or more of the plurality of actions, wherein the workflow design software application is configured to perform, by way of the one or more processors, operations comprising;

receiving selection of the first action and a second action to define the workflow, wherein the first action precedes the second action in the workflow;

receiving an assignment of the output variable of the first action to a second input variable of the second action; and

generating a connection between (i) the output variable and (ii) the second input variable, wherein the value of the output variable is passed from the first action to the second input variable of the second action during execution of the workflow.

4. The computing system of claim 1, wherein obtaining the specification of the API comprises importing the specification from a computing device associated with the API using a target URL.

5. The computing system of claim 1, wherein obtaining the specification of the API comprises receiving the specification as text input by way of a user interface provided by the action design software application.

6. The computing system of claim 1, wherein the operations further comprise:

identifying, within the specification, an additional definition of an additional input of the function;

generating an additional input variable of the action that corresponds to the additional input of the function;

determining a third mapping between the additional input variable and a header parameter to be provided to the API as a hypertext transfer protocol (HTTP) header of the request, wherein execution of the action generates the request that includes in the HTTP header thereof an additional value of the additional input variable according to the third mapping; and

storing the third mapping in the persistent storage to further define the action.

7. The computing system of claim 1, wherein the operations further comprise:

identifying, within the specification, an additional definition of an additional input of the function;

generating an additional input variable of the action that corresponds to the additional input of the function;

determining a third mapping between the additional input variable and a body parameter to be provided to the API as part of a hypertext transfer protocol (HTTP) body of the request, wherein execution of the action generates the request that includes in the HTTP body thereof an additional value of the additional input variable according to the third mapping; and

storing the third mapping in the persistent storage to further define the action.

8. The computing system of claim 1, wherein the operations further comprise:

identifying, within the specification, an additional definition of an additional input of the function;

generating an additional input variable of the action that corresponds to the additional input of the function;

determining a third mapping between the additional input variable and a cookie parameter to be provided to the API within an HTTP cookie header of the request, wherein execution of the action generates the request that includes in the HTTP cookie header thereof an additional value of the additional input variable according to the third mapping; and

storing the third mapping in the persistent storage to further define the action.

9. The computing system of claim 1, wherein the input comprises a plurality of inputs, wherein the input variable comprises a plurality of input variables, and wherein the operations further comprise:

determining, based on the specification and for each respective input variable of the plurality of input variables, an attribute indicating whether the corresponding input is optional or required, wherein the action is executable without providing values for the plurality of input variables corresponding to optional inputs, and wherein the action is not executable without providing values for the plurality of input variables corresponding to required inputs; and

storing, for each respective input variable, an indication of the attribute in the persistent storage to further define the action.

10. The computing system of claim 9, wherein the operations further comprise:

determining, based on the specification, a default value of a particular input variable corresponding to a particular optional input, wherein the function is executed with the default value as the particular optional input when an alternative value is not assigned to the particular input variable; and

storing the default value of the particular input variable in the persistent storage to further define the action.

11. The computing system of claim 1, wherein the action design software application is configured to define a different version of the action for each release version of the API, and wherein each release version of the API is associated with a corresponding specification that defines the attributes thereof.

12. The computing system of claim 1, wherein generating (i) the input variable and (ii) the output variable comprises:

determining that the input of the function is of a first data type;

determining that the output of the function is of a second data type; and

generating (i) the input variable having the first data type and (ii) the output variable having the second data type, wherein integration of the action into the workflow comprises validating that the value of the input variable is of the first data type and that the output variable is passed to an additional variable of the second data type.

13. A computer-implemented method comprising:

obtaining, by an action design software application configured to define an action, a specification that defines attributes of an application programming interface (API);

identifying, by the action design software application and within the specification, definitions of (i) a uniform resource locator (URL) that addresses the API, (ii) a function of the API, (iii) an input of the function, and (iv) an output of the function;

generating, by the action design software application, (i) an input variable of the action that corresponds to the input of the function and (ii) an output variable of the action that corresponds to the output of the function;

determining, by the action design software application, a first mapping between the input variable and a URL parameter of the API,

wherein execution of the action generates a modified version of the URL that includes therein a value of the input variable according to the first mapping and invokes the function by transmitting a request to the modified version of the URL_ during execution of a workflow;

determining, by the action design software application, a second mapping between the output variable and a response from the API, wherein the response is to the request, and wherein

reception from the API of the response causes a value of the output of the function to be stored in the output variable according to the second mapping during execution of the workflow; and

storing the first mapping and the second mapping in persistent storage to define the action,

wherein the persistent storage is configured to store definitions of actions for integration into workflows;

wherein the URL parameter of the API comprises at least one of (i) a URL resource path parameter that identifies a specific resource provided by a server device that hosts the API or (ii) a URL query parameter comprising a key and value pair.

14. The computer-implemented method of claim 13, wherein the action is a first action of a plurality of actions, the computer-implemented method further comprising:

receiving, by a workflow design software application configured to define workflows that include one or more of the plurality of actions, selection of the first action and a second action to define the workflow, wherein the second action precedes the first action in the workflow;

receiving, by the workflow design software application, an assignment of a second output variable of the second action to the input variable of the first action; and

generating, by the workflow design software application, a connection between (i) the second output variable and (ii) the input variable, wherein a value of the second output variable is passed from the second action to the input variable of the first action during execution of the workflow.

15. The computer-implemented method of claim 13, further comprising:

identifying, within the specification, an additional definition of an additional input of the function;

generating an additional input variable of the action that correspond to the additional input of the function;

determining a third mapping between the additional input variable and a header parameter to be provided to the API as a hypertext transfer protocol (HTTP) header of the request, wherein execution of the action generates the request that includes in the HTTP header thereof an additional value of the additional input variable according to the third mapping; and

storing the third mapping in the persistent storage to further define the action.

16. The computer-implemented method of claim 13, further comprising:

identifying, within the specification, an additional definition of an additional input of the function;

generating an additional input variable of the action that correspond to the additional input of the function;

determining a third mapping between the additional input variable and a cookie parameter to be provided to the API within an HTTP cookie header of the request, wherein execution of the action generates the request that includes in the HTTP cookie header thereof an additional value of the additional input variable according to the third mapping; and

storing the third mapping in the persistent storage to further define the action.

17. The computer-implemented method of claim 13, wherein

generating (i) the input variable and (ii) the output variable comprises:

determining that the input of the function is of a first data type;

determining that the output of the function is of a second data type; and

generating (i) the input variable having the first data type and (ii) the output variable having the second data type, wherein integration of the action into the workflow comprises validating that the value of the input variable is of the first data type and that the output variable is passed to an additional variable of the second data type.

18. An article of manufacture including a non-transitory computer-readable medium, having stored thereon program instructions that, upon execution by a computing system configured to define an action, cause the computing system to perform operations comprising:

obtaining a specification that defines attributes of an application programming interface (API);

identifying, within the specification, definitions of (i) a uniform resource locator (URL) that addresses the API, (ii) a function of the API, (iii) an input of the function, and (iv) an output of the function;

generating (i) an input variable of the action that corresponds to the input of the function and (ii) an output variable of the action that corresponds to the output of the function;

determining a first mapping between the input variable and a URL parameter of the API, wherein execution of the action generates a modified version of the URL that includes therein a

value of the input variable according to the first mapping and invokes the function by transmitting a request to the modified version of the URL during execution of a workflow;

determining a second mapping between the output variable and a response from the API, wherein the response is to the request, and

wherein reception from the API of the response causes a value of the output of the function to be stored in the output variable according to the second mapping during execution of the workflow; and

storing the first mapping and the second mapping in persistent storage to define the action,

wherein the persistent storage is configured to store definitions of actions for integration into workflows;

wherein the URL parameter of the API comprises at least one of (i) a URL resource path parameter that identifies a specific resource provided by a server device that hosts the API or (ii) a URL query parameter comprising a key and value pair.