#49
Jun 25

Reading the API

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.
Tags: tools
Download (47.2 MB, 6:55)
alternative download for iPod & Apple TV (19.8 MB, 6:55)
Alternative API Sites

Also, check out railsdocumentation.org, they are writing a book, minidocs, and adding a lot to the API.

25 comments:

Hey Jun 25, 2007 at 01:34

"Documations that cover..." and crash. Something with video. Crashes in that place.

[qtrle @ 0x8939638]Problem: stream_ptr out of bounds (92128 >= 92038)


Hey Jun 25, 2007 at 01:36

Actually never mind. Somewhy it downloaded only 11MB :P. Doing redownload :)


Van Jun 25, 2007 at 01:40

The same problem - only 11Mb was downloaded


chineseGue Jun 25, 2007 at 01:57

my 'mplayerc.exe' stoped too


chineseGuy Jun 25, 2007 at 02:00

but 'mplayerc.exe' work fine with 049_reading_the_api.m4v


Van Jun 25, 2007 at 02:28

yes, it seems only first file is broken


Martin Kjems Jun 25, 2007 at 05:33

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.


Jeremy Jun 25, 2007 at 05:46

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!).


Emil Jun 25, 2007 at 05:55

It crashes for me too after about 2 minutes. I am running linux.


Brian Jun 25, 2007 at 06:00

Episode not playing on my macbook, also.


Fred Lee Jun 25, 2007 at 06:27

Trying to watch it via itunes does not work either.


gregf Jun 25, 2007 at 07:08

Another me to, stops just a minute or so into the video.Download size is 12M


Tristan Dunn Jun 25, 2007 at 07:15

My favorite is: http://www.noobkit.com/


Ryan Bates Jun 25, 2007 at 07:21

Sorry about that guys, seems the file didn't upload properly. I'm re-uploading it and hopefully it will work.


Ryan Bates Jun 25, 2007 at 08:36

Okay, it should be working now. Dreamhost FTP was giving me fits.

@Jeremy & Tristan, thanks, I added it to the show notes.


Carl Fyffe Jun 25, 2007 at 16:36

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.


Cameron Singe Jun 25, 2007 at 19:13

Great video!


Mahmoud Jun 25, 2007 at 22:24

What happens when cliquing on the previous comment poster's name ?


ream88 Jun 26, 2007 at 11:19

So, i've created a [link=http://www.rollyo.com/ream88/ruby_on_rails_api]Rollyo[/link], using the sites mentioned in this GREAT railcast.


ream88 Jun 26, 2007 at 11:20

No BB-Code! :(

http://www.rollyo.com/ream88/ruby_on_rails_api


Ryan Bates Jun 26, 2007 at 14:04

@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...


Brad Gessler Jun 26, 2007 at 22:38

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!


adwin Sep 10, 2007 at 23:37

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 ..


qwewe Mar 29, 2008 at 16:55

gfgfgfg


Rita Mar 30, 2008 at 12:35

Hello

Add your comment:

(required)

(not displayed)

(SKIP THIS ONE)


(required)

subscribe:
sponsored by:
if you want to help:
required:
Get Quicktime Player