Restful service description language

• US 9,817,910 B2
• Filed: 10/19/2012
• Issued: 11/14/2017
• Est. Priority Date: 10/19/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): Arjomandi, Noosha
• Application Number:
  US13/656,032
• Publication Number:
  US 20140115017A1
• Time in Patent Office: 1,852 Days
• CPC Class Codes: G06F 16/958 Organisation or management of web site content, e.g. publishing, maintaining pages or automatic linking

Abstract

A processing device identifies uniform resource identifiers (URIs) for a RESTful (Representational State Transfer) web service in a server and creates server-side metadata describing each of the URIs without nesting metadata of one of the URIs in metadata of another one of the URIs. The processing device creates a file that includes the URIs and the corresponding server-side metadata for the corresponding URI to describe the RESTful web service.

Claims

1. A method comprising:

identifying a first uniform resource identifier (URI) and a second URI for a Representational State Transfer (RESTful) web service in a server, wherein the second URI is nested in metadata of the first URI;

creating, by a processing device, a first set of server-side RESTful service description language (RSDL) metadata describing the first URI;

creating, by the processing device, a second set of server-side RSDL metadata describing the second URI;

creating an RSDL file comprising the first URI, the first set of server-side RSDL metadata, the second URI, and the second set of server-side RSDL metadata; and

formatting content in the RSDL file as a un-nested list of URIs comprising a first entry that includes the first URI and the first set of server-side RSDL metadata and a second entry that includes the second URI and the second set of server-side RSDL metadata.

2. The method of claim 1, wherein the RSDL file comprises server-side metadata describing a method overload corresponding to a subset of a plurality of URIs for the RESTful web service.

3. The method of claim 1, wherein the server-side RSDL metadata for the first URI comprises a description of a header argument of the URI.

4. The method of claim 1, wherein the server-side RSDL metadata for the first URI comprises a description of a body argument of the URI.

5. The method of claim 1, wherein:

information describing a structure of the first URI and the second URI describes a data structure of the first URI and the second URI; and

information describing an operation associated with the first URI or the second URI describes at least one of a type of the operation, an input parameter for the operation, or a return value from the operation.

6. The method of claim 1, wherein the creating the first set of server-side RSDL metadata further comprises creating server-side RSDL metadata each URI of a plurality of URIs.

7. The method of claim 6, wherein creating the server-side RSDL metadata for the first URI, further comprises:

locating source code for the first URI in source code of the RESTful web service;

creating server-side metadata for the URI using a HTTP relationship attribute, a HTTP hypertext attribute, and data in the source code;

identifying a HTTP method for the URI from the source code;

creating server-side metadata describing the HTTP method for the URI;

creating server-side metadata describing a header argument for the URI;

creating server-side metadata describing a body argument for the URI;

creating server-side metadata describing a URI argument for the URI;

creating server-side metadata describing a response argument in view of programming code; and

storing the server-side RSDL metadata for the URI in the server.

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

identify, by the processing device, a first uniform resource identifier (URI) and a second URI for a Representational State Transfer (RESTful) web service in a server, wherein the second URI is nested in metadata of the first URI;

create, by the processing device, a first set of server-side RESTful service description language (RSDL) metadata describing the first URI;

create, by the processing device, a second set of server-side RSDL metadata describing the second URI;

create an RSDL file comprising the first URI, the first set of server-side RSDL metadata, the second URI, and the second set of server-side RSDL metadata; and

format content in the RSDL file as a un-nested list of URIs comprising a first entry that includes the first URI and the first set of server-side RSDL metadata and a second entry that includes the second URI and the second set of server-side RSDL metadata.

9. The non-transitory computer-readable storage medium of claim 8, wherein the file comprises server-side RSDL metadata describing a method overload corresponding to a subset of a plurality of URIs for the RESTful web service.

10. The non-transitory computer-readable storage medium of claim 8, wherein the first set of server-side RSDL metadata for the first URI comprises a description of a header argument of the URI.

11. The non-transitory computer-readable storage medium of claim 8, wherein the first set of server-side RSDL metadata for the first URI comprises a description of a body argument of the URI.

12. The non-transitory computer-readable storage medium of claim 8, wherein to create the server-side RSDL metadata the processing device is further to create server-side RSDL metadata for the first URI.

13. The non-transitory computer-readable storage medium of claim 12, wherein to create the server-side RSDL metadata for the first URI the processing device is further to:

locate source code for first URI in source code of the RESTful web service;

create server-side metadata for the URI using a HTTP relationship attribute, a HTTP hypertext attribute, and data in the source code;

identify a HTTP method for the URI from the source code;

create server-side metadata describing the HTTP method for the URI;

create server-side metadata describing a header argument for the URI;

create server-side metadata describing a body argument for the URI;

create server-side metadata describing a URI argument for the URI;

create server-side metadata describing a response argument in view of programming code; and

store the server-side RSDL metadata for the URI in the server.

14. A system comprising:

a memory; and

a processing device, operatively coupled to the memory, to;

identify a first uniform resource identifier (URI) and a second URI for a Representational State Transfer (RESTful) web service in a server, wherein the second URI is nested in metadata of the first URI;

create a first set of server-side RESTful service description language (RSDL) metadata describing the first URI;

creating, by the processing device, a second set of server-side RSDL metadata describing the second URI;

create an RSDL file comprising the first URI, the first set of server-side RSDL metadata, the second URI, and the second set of server-side RSDL metadata; and

formatting content in the RSDL file RSDL file as a un-nested list of URIs comprising a first entry that includes the first URI and the first set of server-side RSDL metadata and a second entry that includes the second URI and the second set of server-side RSDL metadata.

15. The system of claim 14, wherein the file comprises server-side RSDL metadata describing a method overload corresponding to a subset of a plurality of URIs for the RESTful web service.

16. The system of claim 14, wherein the server-side RSDL metadata for the first URI comprises a description of a header argument of the URI.

17. The system of claim 14, wherein the server-side RSDL metadata for the first URI comprises a description of a body argument of the URI.

18. The system of claim 14, wherein to create the server-side RSDL metadata, the processing device is further to create server-side RSDL metadata each URI of a plurality of URIs.

19. The system of claim 18, wherein to create server-side RSDL metadata for the first URI, the processing device is further to:

locate source code for the first URI in source code of the RESTful web service;

create server-side metadata for the URI using a HTTP relationship attribute, a HTTP hypertext attribute, and data in the source code;

identify a HTTP method for the URI from the source code;

create server-side metadata describing the HTTP method for the URI;

create server-side metadata describing a header argument for the URI;

create server-side metadata describing a body argument for the URI;

create server-side metadata describing a URI argument for the URI;

create server-side metadata describing a response argument in view of programming code; and

store the server-side RSDL metadata for the URI in the server.