kakao / s2graph

This code base is retained for historical interest only, please visit Apache Incubator Repo for latest one
https://github.com/apache/incubator-s2graph
Other
250 stars 32 forks source link

[suggestion] more RESTful API path #260

Closed iolo closed 8 years ago

iolo commented 8 years ago

this is NOT a bug. just a suggestion.

IMHO, current REST API path is not so RESTful. mostly, HTTP method is duplicated in path again. :S

for example(for compatibility, I prepend `api version* in path),

I know, query APIs are not easy as above. ;) Those are complex and special cases.

There are too many params to use these:

for query APIs, we need a new approach(similar to prepared statement in RDBMS):

for example, the query APIs could be provided with two steps:

with this approach, we can provide more fine-graned apis:

I guess, we need more consideration for easy and clear apis.

HyunsungJo commented 8 years ago

@iolo, Thank you very much for your interest and helpful ideas. This is not the first time someone pointed out that the S2Graph API is not RESTful. So we are fully aware of the issue and will try to enhance the usability of the API taking your suggestion under consideration. Meanwhile, let me go ahead and close this issue since this is expected to be a long-term process.