Supporting software application developers to iteratively refine requirements for web application programming interfaces

• US 9,588,739 B2
• Filed: 06/18/2015
• Issued: 03/07/2017
• Est. Priority Date: 02/16/2015
• Status: Expired due to Fees

• Current Assignee: International Business Machines Corporation
• Original Assignee: International Business Machines Corporation
• Inventors: Cuomo, Gennaro A., Jamjoom, Hani T., Laredo, Jim A., Natarajan, Arjun, Rajagopalan, Shriram, Williams, Daniel J., Wittern, John E.
• Primary Examiner(s): Dam, Tuan Q.
• Assistant Examiner(s): BERMAN, STEPHEN DAVID
• Application Number:
  US14/743,171
• Publication Number:
  US 20160239546A1
• Time in Patent Office: 628 Days
• Field of Search: None
• US Class Current: 1/1
• CPC Class Codes: G06F 16/24575 using context
• CPC Class Codes: G06F 16/24578 using ranking
• CPC Class Codes: G06F 16/248 Presentation of query results
• CPC Class Codes: G06F 16/28 Databases characterised by their database models, e.g. relational or object models
• CPC Class Codes: G06F 16/288 Entity relationship models
• CPC Class Codes: G06F 16/951 Indexing; Web crawling techniques
• CPC Class Codes: G06F 16/9535 Search customisation based on user profiles and personalisation
• CPC Class Codes: G06F 16/9538 Presentation of query results
• CPC Class Codes: G06F 8/10 Requirements analysis; Specification techniques
• CPC Class Codes: G06F 8/20 Software design
• CPC Class Codes: H04L 67/01 Protocols
• CPC Class Codes: H04L 67/02 based on web technology, e.g. hypertext transfer protocol [HTTP]

Abstract

Web API recommendations for a context of an application are provided. A ranked list of recommended Web APIs and a set of Web API recommendations regarding the context of the application is sent to a client device via a network. In response to determining that a selection of a set of Web APIs in the ranked list of recommended Web APIs was received, the set of Web APIs selected is added to the context of the application to generate a new context of the application. A display of a relationship among the set of Web APIs added to the new context of the application is sent to the client device via the network.

Claims

1. A computer-implemented method for providing Web Application Programming Interface (API) recommendations for a context of an application, the computer-implemented method comprising:

sending, by a computer, a ranked list of Web APIs recommended and a set of Web API recommendations regarding the context of the application, as a result of input containing current Web API requirements and the set of Web API recommendations determined by traversal of relationships within a graph structure of a graph-based Web API data model, to a client device via a network, wherein each node in the graph structure represents an end point including one of a corresponding Web API, a specific portion of a Web API, common Web API characteristics and Web API attributes, and wherein Web APIs recommended in the ranked list of Web APIs recommended are ranked based on the relationships of the Web APIs recommended to the context of the application;

wherein set of Web API recommendations include instructions on how to use the Web APIs within the ranked list of Web APIs;

wherein the relationships of the Web APIs recommended to the context of the application include matching data formats;

responsive to the computer determining that a selection of a set of Web APIs in the ranked list of Web APIs recommended was received, adding, by the computer, the selection of the set of Web APIs to the context of the application to generate a new context of the application; and

sending, by the computer, a display of a relationship among the selection of the set of Web APIs in the ranked list of Web APIs recommended added to the new context of the application to the client device via the network.

2. The computer-implemented method of claim 1 further comprising:

receiving, by the computer, the context of the application from the client device via the network;

receiving, by the computer, search terms that include initial Web API requirements as the current Web API requirements for the context of the application from the client device via the network; and

defining, by the computer, a Web API recommendation query that includes the search terms and the selection of the set of Web APIs for the context of the application.

3. The computer-implemented method of claim 2, wherein the initial Web API requirements for the context of the application include at least one of an initial list of required Web APIs selected by a software application developer for the context of the application, a Web API category from which to select and recommend other Web APIs for the context of the application, full-text search terms used to search the graph-based Web API data model for other Web APIs recommended for the context of the application, and one or more attributes corresponding to the other Web APIs recommended.

4. The computer-implemented method of claim 1 further comprising:

sending, by the computer, a Web API recommendation query for the context of the application to a Web API relationship engine that contains the graph-based Web API data model comprising Web API descriptions, attributes, and relationships;

matching, by the computer, Web API names and descriptions and identify relationships to required Web API attributes in the context of the application using the graph-based Web API data model by the Web API relationship engine; and

receiving, by the computer, a search result from the Web API relationship engine containing a list of Web APIs recommended for the context of the application.

5. The computer-implemented method of claim 4 further comprising:

filtering, by the computer, the list of Web APIs recommended for the context of the application based on one or more attributes of the Web APIs recommended in the list of Web APIs recommended, to create a filtered list.

6. The computer-implemented method of claim 5 further comprising:

ranking, by the computer, one or more Web APIs recommended in the filtered list based on one or more relationships of the Web APIs recommended to the context of the application.

7. The computer-implemented method of claim 6, wherein the one or more relationships of the Web APIs recommended include at least one of common historic usage, common attributes, and matching data formats.

8. The computer-implemented method of claim 1, wherein the context of the application is a set of aspects related to development and execution of the application.