Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement REST API #16

Open
jishnu7 opened this issue Feb 28, 2014 · 7 comments
Open

Implement REST API #16

jishnu7 opened this issue Feb 28, 2014 · 7 comments
Milestone

Comments

@jishnu7
Copy link
Member

jishnu7 commented Feb 28, 2014

We should have a REST (or REST like) api for the ease of API usage in other languages. Existing JSON-RPC, need to be present to allow backward compatibility.

I propose an API similar to what twitter has

Sample API calls:

POST api.silpa.org.in/payyans/ASCII2Unicode
Paramets: text, font
Response: JSON data

POST api.silpa.org.in/payyans/Unicode2ASCII
Paramets: text, font
Response: JSON data

Generic:

GET/POST (http://api.silpa.org.in/module/function_name or http://silpa.org.in/api/module/function_name)
Parameters: function parameters
Response: JSON encoded return value from function

@jishnu7 jishnu7 added this to the Gsoc 2014 milestone Feb 28, 2014
@shashisp
Copy link

shashisp commented Mar 1, 2014

so, for Silpa-Flask REST API's we need to write all silpa modules as flask views and using Flask-RESTful , we can convert output in to json, is that a right approach?

@jishnu7
Copy link
Member Author

jishnu7 commented Mar 2, 2014

Since we already have a module structure and everything in place, I think
we don't need to use an external library like Restful.

Regards,
Jishnu

http://blog.thecodecracker.com
http://twitter.com/jishnu7
On Mar 2, 2014 4:27 AM, "Shashi Kumar P" [email protected] wrote:

so, for Silpa-Flask REST API's we need to write all silpa modules as flask
views and using Flask-RESTful , we can convert output in to json, is that a
right approach?

Reply to this email directly or view it on
GitHubhttps://github.com//issues/16#issuecomment-36439635
.

@copyninja
Copy link
Member

I agree with @jishnu7 We might not need external library like Flask-Restful, we are not looking for pure REST api instead we need some http api's in the format described by @jishnu7 above

@aashay201297
Copy link

What is the current status on this? If nobody is working, I would like to work on this. Please respond.

@copyninja
Copy link
Member

I think work is partially done by @balasankarc or @jerinphilip . You can work on this if you are interested. @jerinphilip @balasankarc Please provide what is done and what is pending status.

@balasankarc
Copy link
Member

@aashay201297 In the current situation, this requires namespacing of modules to be completed, which is only partially done. I'll check which all modules are completed and update (or you can check the modules' and see if namespacing is implemented).

@jerinphilip may comment on how to proceed after that, as he did the initial work on REST API last year.

@aashay201297
Copy link

@balasankarc i will try to find out about the implemented namespacing but it would be good if you or @jerinphilip can give more details as you have already worked on this issue. Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants