#49 Reading the API
Jun 25, 2007 | 6 minutes | Tools
The Rails API docs are very useful but can be difficult to read. This episode will give some tips on reading the docs and mention a few alternative sites for accessing the API. Update: sorry about the broken movie, it should work now.
"Documations that cover..." and crash. Something with video. Crashes in that place.
[qtrle @ 0x8939638]Problem: stream_ptr out of bounds (92128 >= 92038)
Actually never mind. Somewhy it downloaded only 11MB :P. Doing redownload :)
The same problem - only 11Mb was downloaded
my 'mplayerc.exe' stoped too
but 'mplayerc.exe' work fine with 049_reading_the_api.m4v
yes, it seems only first file is broken
Something is fishy with this 049_reading_the_api.mov file. -it stops playing after 1 min 44secs.
Too bad , i like this podcast alot.
You forgot http://www.railsdocumentation.org, where you can get our patched version of the API (which documents many of the methods in much greater detail!).
It crashes for me too after about 2 minutes. I am running linux.
Episode not playing on my macbook, also.
Trying to watch it via itunes does not work either.
Another me to, stops just a minute or so into the video.Download size is 12M
My favorite is: http://www.noobkit.com/
Sorry about that guys, seems the file didn't upload properly. I'm re-uploading it and hopefully it will work.
Okay, it should be working now. Dreamhost FTP was giving me fits.
@Jeremy & Tristan, thanks, I added it to the show notes.
By far, my most favorite API site is Ruby Search: http://labs.parkerfox.co.uk/ruby.search/
It hits the Rails API and the Ruby API at the same time.
What happens when cliquing on the previous comment poster's name ?
No BB-Code! :(
@Mahmoud, the author just forgot to prefix their site with "http://". I fixed it so it works now.
@ream88, sorry about no markup. On my long list of stuff to do...
I've found http://www.rorapi.com/ by far the cleanest Rails search engine. It uses Google Co-op and indexes the Core Ruby, RoR, Prototype, and Scriptaculous APIs.
To sweeten the deal there is a Firefox search plug-in!
please teach also how to look the methods that belong to a class.
for example how to know that ActiveRecord::Base has methods named belongs_to, has_many, etc ... (since the API was on it child, but it doesnt mentioned very clear in ActiveRecord::Base).
For me Javadoc is the best API Doc because it list the parents method as well ... well. the RAILS / Ruby API doesnt list it all ..
The link to http://railsmanual.org/ no longer takes you to the an API. It redirects to a site that may not be safe for work.
I completely agree with you, reading some of the docs can be a pain in the butt. The links you posted have been very useful for me and I will use them in the future. Thanks a lot for posting and I hope you keep up the good work for this site and we can see more of you. Alternative sites to process API are not an easy thing to find :)
Railsapi.org was using new Rails Logo which was announced in 2015! see at 5:36