Rails REST resources on the real world (real)

Hi @all!

First of all let me congratulate all the team involved on the creation of Rails 2! What an excellent advancement on an advanced framework!

I have a question about the "new" RESTful resources. Imagine I use extensively this new approach on a new website. What is the best way to inform my users about the RESTful resources? Is there some kind of automatic generation of documentation? Or am I missing the big picture completely?

Thank you for your support!
Rúben

I believe he wants to generate documentation about his available RESTful API.

And actually that would be a cool tool.

*Brain starts moving...*

--Jeremy

I believe he wants to generate documentation about his available
RESTful API.

And actually that would be a cool tool.

*Brain starts moving...*

--Jeremy

Yes that was exactly what I was thinking! I want to tell the users:
"hey! I have a beautiful API! How do you use it? Here is the
documentation: ...".

I don't really know if this is somewhat possible, but at least a
skeleton documentation seems feasible. I could then fill the
description about each method. Or it could be copied from the
existing application documentation :slight_smile:

Rúben

Yeah, you could do that, but you'd have to :nodoc: all the stuff you
didn't want.

It'd be cool to have an RDoc hooked tool that you could say something like:

    resdoc accounts sessions pages

...and then it would crawl into your controllers directory, grab the
documentation for it, and then spit out a nice looking REST API doc
(which would likely look different than an RDoc). In RDoc, all the
methods would look like `create`, `update`, etc for every controller,
making them indistinguishable. If a person wanted to learn about the
resources, they'd have to dig into your classes, and if they do that,
they're looking at the docs for your app not the exposed API.

--Jeremy

how about just

   rake routes

to show the pertinent end points and explain how they are used?

c