https://github.com/mmorga/restdoc
RESTful documentation generation for Rails Apps
https://github.com/mmorga/restdoc
Last synced: 4 months ago
JSON representation
RESTful documentation generation for Rails Apps
- Host: GitHub
- URL: https://github.com/mmorga/restdoc
- Owner: mmorga
- Created: 2009-06-08T03:19:36.000Z (about 17 years ago)
- Default Branch: master
- Last Pushed: 2009-06-15T05:53:59.000Z (about 17 years ago)
- Last Synced: 2023-04-13T07:51:13.461Z (about 3 years ago)
- Language: Ruby
- Homepage:
- Size: 89.8 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rdoc
- Changelog: History.txt
Awesome Lists containing this project
README
= restdoc
* http://github.com/mmorga/restdoc
== DESCRIPTION:
RestDoc reads your Rails project's routes and produces API documentation for your application's
RESTful interface. Additional formatting of the RDoc comments for your methods can be used to
produce API docs that include required parameters, authentication requirements, format of return
values and other useful information for your application's users.
== FEATURES/PROBLEMS:
* Produces RDoc like documentation for the RESTful interface of a Rails application.
== SYNOPSIS:
Go to the folder where your rails project lives.
restdoc .
== REQUIREMENTS:
* rdoc
== INSTALL:
sudo gem install restdoc
To install the gem within your rails app, edit the config/environment.rb file and add the config.gem
commands for yard and restdoc as shown below.
Rails::Initializer.run do |config|
config.gem "yard"
config.gem "restdoc", :lib => "rest_doc"
end
[OPTIONAL] To freeze the gems to your vendor directory (recommended) execute:
rake gems:unpack
To enable the rake task to generate restful documentation, add the following to your Rakefile.
require 'rest_doc'
== LICENSE:
(The MIT License)
Copyright (c) 2009 Mark Morga
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.