how to design a api?

rubyonrails-talk
1

hi,everyone. now i start to design a api. the url like this http://localhost:3000/api?seckey=123&&post_id=1 the visitor need a seckey to access auth.and get info via json. so i dont think thats a good api. i need your answers.thx

2

REST: http://pivotallabs.com/users/jdean/blog/articles/1419-building-a-fast-lightweight-rest-service-with-rails-3-

or

SOAP: http://railshackers.com/category/soap-api/

3

You should checkout Edge Rails. edgeguides.rubyonrails.org/ api_app.html has some interesting information.

4

I have 2 boards on Quora that contain some useful links:

http://www.quora.com/Martin-Wawrusch/REST-API-Implementer-Resources

http://www.quora.com/Martin-Wawrusch/Oauth-2-Resources-For-Provider-Implementers

You might also want to consider looking into this interactive book project: http://designinghypermediaapis.com

and take a look at github’s API design here: http://develop.github.com/

also, read this: http://blog.steveklabnik.com/posts/2011-07-03-nobody-understands-rest-or-http and part II of it

and don’t forget to use patch instead of put when applicable :slight_smile:

Cheers

Martin

5

muchas gracias all.

i was considering that maybe i could use HMAC way to implement this.is it a good way.