{"id":43413081,"url":"https://github.com/mmorga/restdoc","last_synced_at":"2026-02-02T17:02:12.698Z","repository":{"id":587352,"uuid":"221288","full_name":"mmorga/restdoc","owner":"mmorga","description":"RESTful documentation generation for Rails Apps","archived":false,"fork":false,"pushed_at":"2009-06-15T05:53:59.000Z","size":92,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-04-13T07:51:13.461Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mmorga.png","metadata":{"files":{"readme":"README.rdoc","changelog":"History.txt","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2009-06-08T03:19:36.000Z","updated_at":"2015-04-24T09:53:35.000Z","dependencies_parsed_at":"2022-07-07T18:02:14.015Z","dependency_job_id":null,"html_url":"https://github.com/mmorga/restdoc","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"purl":"pkg:github/mmorga/restdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmorga%2Frestdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmorga%2Frestdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmorga%2Frestdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmorga%2Frestdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mmorga","download_url":"https://codeload.github.com/mmorga/restdoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmorga%2Frestdoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29015750,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-02T16:17:30.374Z","status":"ssl_error","status_checked_at":"2026-02-02T15:58:50.469Z","response_time":58,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-02-02T17:02:09.232Z","updated_at":"2026-02-02T17:02:12.688Z","avatar_url":"https://github.com/mmorga.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"= restdoc\n\n* http://github.com/mmorga/restdoc\n\n== DESCRIPTION:\n\nRestDoc reads your Rails project's routes and produces API documentation for your application's\nRESTful interface.  Additional formatting of the RDoc comments for your methods can be used to \nproduce API docs that include required parameters, authentication requirements, format of return \nvalues and other useful information for your application's users.\n\n\n== FEATURES/PROBLEMS:\n\n* Produces RDoc like documentation for the RESTful interface of a Rails application.\n\n== SYNOPSIS:\n\nGo to the folder where your rails project lives.\n\n\u003ccode\u003erestdoc .\u003c/code\u003e\n\n== REQUIREMENTS:\n\n* rdoc\n\n== INSTALL:\n\n\u003ccode\u003esudo gem install restdoc\u003c/code\u003e\n\nTo install the gem within your rails app, edit the config/environment.rb file and add the config.gem \ncommands for yard and restdoc as shown below.\n\n\tRails::Initializer.run do |config|\n\t  config.gem \"yard\"\n\t  config.gem \"restdoc\", :lib =\u003e \"rest_doc\"\n\n\tend\n\n[OPTIONAL] To freeze the gems to your vendor directory (recommended) execute:\n\n\u003ccode\u003erake gems:unpack\u003c/code\u003e\n\nTo enable the rake task to generate restful documentation, add the following to your Rakefile.\n\n\u003ccode\u003erequire 'rest_doc'\u003c/code\u003e\n\n== LICENSE:\n\n(The MIT License)\n\nCopyright (c) 2009 Mark Morga\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmorga%2Frestdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmmorga%2Frestdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmorga%2Frestdoc/lists"}