Preserving restful web service structure in a client consuming the restful web service

• US 9,465,587 B2
• Filed: 11/30/2012
• Issued: 10/11/2016
• Est. Priority Date: 11/30/2012
• Status: Active Grant

• Current Assignee: Red Hat Israel Ltd. (International Business Machines Corporation)
• Original Assignee: Red Hat Israel Ltd. (International Business Machines Corporation)
• Inventors: Pasternak, Michael
• Primary Examiner(s): Dao, Thuy
• Assistant Examiner(s): Rivera, Anibal
• Application Number:
  US13/690,466
• Publication Number:
  US 20140157227A1
• Time in Patent Office: 1,411 Days
• US Class Current: 1/1
• CPC Class Codes: G06F 16/9566 URL specific, e.g. using aliases, detecting broken or misspelled links
• CPC Class Codes: G06F 8/30 Creation or generation of source code
• CPC Class Codes: G06F 8/40 Transformation of program code
• CPC Class Codes: G06F 9/54 Interprogram communication

Abstract

A computer system identifies a uniform resource identifier (URI) that corresponds to a resource of a RESTful web service. The URI contains elements. The computer system identifies a relationship between the elements of the URI and creates programming code for a method of a software development kit (SDK) client. The method reflects the relationships between the elements of the URI to facilitate communication with the resource of the RESTful web service.

Claims

1. A processor-executed method comprising:

identifying a uniform resource identifier (URI) that corresponds to a resource of a RESTful (Representational State Transfer) web service provided by a server, the URI comprising a plurality of elements;

identifying relationships between the plurality of elements of the URI;

determining an entry point of the RESTful web service from the relationships between the plurality of elements, the entry point being a root resource class into the RESTFUL web service;

determining a name of the entry point in the URI from the relationships of the plurality of elements in the URI;

creating programming code for a method of a software development kit (SDK) client by creating programming code for an entry point class using the name of the entry point in the URI; and

replicating, by a processing device, the relationships between the plurality of elements of the URI in the programming code for the method of the SDK client, the programming code comprising programming code corresponding to the entry point.

2. The method of claim 1, wherein identifying relationships between the plurality of elements of the URI comprises:

determining a collection of the RESTful web service from the relationships between the plurality of elements of the URI.

3. The method of claim 2, wherein creating programming code for the method comprises:

creating programming code for a collection class for the collection using a name of the collection in the URI;

adding a collection pointer, that points to the collection class, in the entry point class programming code; and

adding a method pointer, that points to the method, in the collection class programming code, wherein the entry point class programming code, the collection class programming code, the collection pointer, and the method pointer create a relationship that is identified in the URI.

4. The method of claim 3, further comprising:

adding the entry point class programming code and the collection class programming code to the software development kit client.

5. The method of claim 1, wherein identifying the URI comprises:

identifying a URI description for the URI in RESTful service descriptive language (RSDL) for the RESTful web service.

6. The method of claim 1, further comprising:

identifying a second URI that corresponds to a second resource of the RESTful web service, the second URI comprising a second plurality of elements;

identifying relationships between the second plurality of elements of the second URI; and

replicating the relationships between the second plurality of elements of the second URI in programming code for a second method of the SDK client to facilitate communication with the second resource of the RESTful web service.

7. A non-transitory computer-readable storage medium including instructions that, when executed by a processing device, cause the processing device to:

identify a uniform resource identifier (URI) that corresponds to a resource of a RESTful (Representational State Transfer) web service provided by a server, the URI comprising a plurality of elements;

identify relationships between the plurality of elements of the URI;

determine an entry point of the RESTful web service from the relationships between the plurality of elements, the entry point being a root resource class into the RESTFUL web service;

determine a name of the entry point in the URI from the relationships of the plurality of elements in the URI;

create programming code for a method of a software development kit (SDK) client by creating programming code for an entry point class using the name of the entry point in the URI; and

replicate, by the processing device, the relationships between the plurality of elements of the URI in the programming code for the method of the SDK client, the programming code comprising programming code corresponding to the entry point.

8. The non-transitory computer-readable storage medium of claim 7, wherein to identify relationships between the plurality of elements of the URI comprises the processing device to:

determine a collection of the RESTful web service from the relationships between the plurality of elements of the URI.

9. The non-transitory computer-readable storage medium of claim 8, wherein to create programming code for the method comprises the processing device to:

create programming code for a collection class for the collection using a name of the collection in the URI;

add a collection pointer, that points to the collection class, in the entry point class programming code; and

add a method pointer, that points to the method, in the collection class programming code, wherein the entry point class programming code, the collection class programming code, the collection pointer, and the method pointer create a relationship that is identified in the URI.

10. The non-transitory computer-readable storage medium of claim 9, wherein the processing device is further to:

add the entry point class programming code and the collection class programming code to the software development kit client.

11. The non-transitory computer-readable storage medium of claim 7, wherein to identify the URI comprises the processing device to:

identify a URI description for the URI in RESTful service descriptive language (RSDL) for the RESTful web service.

12. The non-transitory computer-readable storage medium of claim 7, wherein the processing device is further to:

identify a second URI that corresponds to a second resource of the RESTful web service, the second URI comprising a second plurality of elements;

identify relationships between the second plurality of elements of the second URI; and

replicate the relationships between the second plurality of elements of the second URI in programming code for a second method of the SDK client to facilitate communication with the second resource of the RESTful web service.

13. A system comprising:

a memory; and

a processing device operatively coupled to the memory to;

identify a uniform resource identifier (URI) that corresponds to a resource of a RESTful (Representational State Transfer) web service provided by a server, the URI comprising a plurality of elements;

identify relationships between the plurality of elements of the URI;

determine an entry point of the RESTful web service from the relationships between the plurality of elements, the entry point being a root resource class into the RESTFUL web service;

determine a name of the entry point in the URI from the relationships of the plurality of elements in the URI;

create programming code for a method of a software development kit (SDK) client by creating programming code for an entry point class using the name of the entry point in the URI; and

replicate the relationships between the plurality of elements of the URI in the programming code for the method of the SDK client, the programming code comprising programming code corresponding to the entry point.

14. The system of claim 13, wherein to identify relationships between the plurality of elements of the URI comprises the processing device to:

determine a collection of the RESTful web service from the relationships between the plurality of elements of the URI.

15. The system of claim 14, wherein to create programming code for the method comprises the processing device to:

create programming code for a collection class for the collection using a name of the collection in the URI;

add a collection pointer, that points to the collection class, in the entry point class programming code; and

add a method pointer, that points to the method, in the collection class programming code, wherein the entry point class programming code, the collection class programming code, the collection pointer, and the method pointer create a relationship that is identified in the URI.

16. The system of claim 15, wherein the processing device is further to:

add the entry point class programming code and the collection class programming code to the software development kit client.

17. The system of claim 13, wherein to identify the URI comprises the processing device to:

identify a URI description for the URI in RESTful service descriptive language (RSDL) for the RESTful web service.

18. The system of claim 13, wherein the processing device is further to:

identify a second URI that corresponds to a second resource of the RESTful web service, the second URI comprising a second plurality of elements;

identify relationships between the second plurality of elements of the second URI; and

replicate the relationships between the second plurality of elements of the second URI in programming code for a second method of the SDK client to facilitate communication with the second resource of the RESTful web service.