资 源 简 介
RAPIDoc
RAPIDoc is a controller generator for your Rails Restful API. It generates a API controller, by simply invoking...
./generate
It parses the controllers you specify, and generates a ApiController with appropriate views for it. This makes it very easy to document your Rest API. For methods you use, and according to ERB templates it generates the view for you.
EXAMPLE Class documentation
```
=begin apidoc
name:: /projects
json:: <%=Project.find(:first).to_json %>
xml:: <%=Project.find(:first).to_xml %>
This resource can be used to show edit and list projects. A project is a one floorplanner. A project
has multiple floors, which can contain multiple designs.
=end
```
EXAMPLE Method documentation
```
=begin apidoc
url:: /projects
method:: GET
access:: FREE
return:: [JSON|XML] - some project
param:: page:int - the page
param:: per_page:int - max items per page
Get a list of projects.
