System and method for specifying properties for a protocol-compliant uniform resource locator
A graphical user interface is configured to guide a user through a method of creating a RESTful API protocol-compliant URL, without requiring that the user be familiar with syntax of the RESTful API protocol. The graphical user interface includes a URL output that indicates to the user features within a user-edited URL that render the user-edited URL non-compliant with the RESTful API protocol. The graphical user interface includes a set of graphical input devices to solicit and receive from the user input specifying a set of query options, which user input is used to define the RESTful API protocol-compliant URL. The graphical user interface is automatically customized to solicit and receive from the user input only for options available from a specific data service.
1. A method of creating a uniform resource locator that complies with a RESTful API protocol (a “protocol-compliant” URL) at a computer remote from a data service, the method comprising:
obtaining, from a metadata source, metadata describing source data available from the data service;
customizing a graphical user interface (“GUI”) by populating a set of graphical input devices within the GUI with information specified by the metadata, such that the GUI is configured to solicit and receive user input specifying a set of query options to request, from the data service, data available from the data service, wherein customizing the graphical user interface comprises:
populating and displaying first window with a set of column icons, each column icon of the set of column icons associated with corresponding data available from the data service, and each column icon of the set of column icons specified by the metadata from the metadata source; and
providing a second window configured to receive one or more column icons dragged from the first window and dropped into the second window;
receiving user input via the graphical user interface, the user input comprising receipt at the second window of at least one column icon of the set of column icons dragged from the first window and dropped into the second window; and
generating the protocol-compliant uniform resource locator by application of a set of rules to the user input, the protocol-compliant uniform resource locator configured to solicit from the data source response data defined by the user input.
2. The method of claim 1 , wherein:
receiving at the second window a plurality of column icons from the set of column icons, said plurality of column icons arranged in a column order in the second window; and wherein:
generating the protocol-compliant uniform resource locator by application of a set of rules to the user input comprises generating the protocol-compliant uniform resource locator configured to solicit from the data source responsive data defined by the user input, and in the column order.
3. The method of claim 1 , wherein the metadata source is the data service.
4. The method of claim 1 , wherein application of a rule from the set of rules comprises applying a rule that formats the user input into a format defined by the RESTful API protocol.
5. The method of claim 1 , wherein application of a rule from the set of rules comprises adding, to the user input, a prefix defined by the RESTful API protocol.
6. The method of claim 1 , wherein generating the protocol-compliant uniform resource locator by application of a set of rules to the user input comprises, for at least one item of user input:
appending a prefix to said user input and adding the prefix and user input to the protocol-compliant uniform resource locator.
7. The method of claim 1 , wherein:
the metadata describes a plurality of categories of source data available from the available from the data service;
customizing a graphical user interface comprises providing a third graphical input device configured to receive user input specifying a set of filters, wherein each filter further limits the data of a selected category provided as responsive data; and wherein
receiving user input via the graphical user interface comprises receiving user specification of each filter in the set of filters; and wherein
generating the protocol-compliant uniform resource locator by application of a set of rules to the user input comprises formatting said specification of each filter in the set of filters into a format defined by the RESTful API protocol, such that protocol-compliant uniform resource locator is configured to cause the data service to provide, as responsive data, a filtered subset of source data from the selected category.
8. A computer-implemented system for creating a uniform resource locator that complies with a RESTful API protocol, said uniform resource locator being a “protocol-compliant” URL, for requesting source data from a data service, the system comprising:
a communications interface configured to obtain, from a metadata source, metadata describing source data available from the data service;
a graphical user interface driver configured to customize a graphical user interface (“GUI”) by populating a set of graphical input devices within the GUI with information specified by the metadata, such that the GUI is configured to solicit and receive user input specifying a set of query options to request, from the data service, data available from the data service, wherein customizing the graphical user interface comprises:
populating and displaying first window with a set of column icons, each column icon of the set of column icons associated with corresponding data available from the data service, and each column icon of the set of column icons specified by the metadata from the metadata source; and
providing a second window configured to receive one or more column icons dragged from the first window and dropped into the second window; and
a protocol-compliant URL generator configured:
to receive user input comprising receipt at the second window of at least one column icon of the set of column icons dragged from the first window and dropped into the second window, and
to apply a set of rules to the user input, said user input comprising to produce, from said user input, a protocol-compliant URL.
9. The computer-implemented system of claim 8 , wherein
receiving at the second window of at least one column icon comprises receiving a plurality of column icons from the set of column icons, said plurality of column icons arranged in a column order in the second window; and wherein:
generating the protocol-compliant uniform resource locator by application of a set of rules to the user input comprises generating the protocol-compliant uniform resource locator configured to solicit from the data source responsive data defined by the user input, and in the column order.
10. The computer-implemented system of claim 8 , wherein the metadata source is the data service.
11. The computer-implemented system of claim 8 , wherein application of a set of rules comprises applying a rule that formats the user input into a format defined by the RESTful API protocol.
12. The computer-implemented system of claim 8 , wherein application of a set of rules comprises adding, to at least one item of the user input, a prefix defined by the RESTful API protocol.
13. The computer-implemented system of claim 8 , wherein generating the protocol-compliant uniform resource locator by application of a set of rules to the user input comprises, for at least one item of user input:
appending a prefix to said user input and adding the prefix and user input to the protocol-compliant uniform resource locator.
14. The computer-implemented system of claim 8 , wherein
the metadata describes a plurality of categories of source data available from the available from the data service;
customizing a graphical user interface comprises providing a third graphical input device configured to receive user input specifying a set of filters, wherein each filter further limits the data of a selected category provided as responsive data; and wherein
receiving user input via the graphical user interface comprises receiving user specification of each filter in the set of filters; and wherein
generating the protocol-compliant uniform resource locator by application of a set of rules to the user input comprises formatting said specification of each filter in the set of filters into a format defined by the RESTful API protocol, such that protocol-compliant uniform resource locator is configured to cause the data service to provide, as responsive data, a filtered subset of source data from the selected category.
15. A non-transitory computer-readable medium having computer code thereon, the computer code configured to be executed by a computer, the computer code causing the computer to execute a method comprising:
obtaining, from a metadata source, metadata describing source data available from the data service;
customizing a graphical user interface (“GUI”) by populating a set of graphical input devices within the GUI with information specified by the metadata, such that the GUI is configured to solicit and receive user input specifying a set of query options to request, from the data service, data available from the data service, wherein customizing the graphical user interface comprises:
populating and displaying first window with a set of column icons, each column icon of the set of column icons associated with corresponding data available from the data service, and each column icon of the set of column icons specified by the metadata from the metadata source; and
providing a second window configured to receive one or more column icons dragged from the first window and dropped into the second window;
receiving user input via the graphical user interface, the user input comprising receipt at the second window of at least one column icon of the set of column icons dragged from the first window and dropped into the second window; and
generating the protocol-compliant uniform resource locator by application of a set of rules to the user input, the protocol-compliant uniform resource locator configured to solicit from the data source response data defined by the user input.
16. The non-transitory computer-readable medium of claim 15 , wherein the method further comprises:
receiving at the second window a plurality of column icons from the set of column, said plurality of column icons arranged in a column order in the second window; and wherein:
generating the protocol-compliant uniform resource locator by application of a set of rules to the user input comprises generating the protocol-compliant uniform resource locator configured to solicit from the data source responsive data defined by the user input, and in the column order.
17. The non-transitory computer-readable medium of claim 15 , wherein the metadata source is the data service.
18. The non-transitory computer-readable medium of claim 15 , wherein application of a rule from the set of rules comprises applying a rule that formats the user input into a format defined by the RESTful API protocol.
19. The non-transitory computer-readable medium of claim 15 , wherein application of a rule from the set of rules comprises adding, to at least one item of the user input, a prefix defined by the RESTful API protocol.
20. The non-transitory computer-readable medium of claim 15 , wherein generating the protocol-compliant uniform resource locator by application of a set of rules to the user input comprises, for at least one item of user input:
appending a prefix to said user input and adding the prefix and user input to the protocol-compliant uniform resource locator.