{"id":16475948,"url":"https://github.com/softprops/sinatra-doc","last_synced_at":"2026-03-04T02:31:56.576Z","repository":{"id":714609,"uuid":"361524","full_name":"softprops/sinatra-doc","owner":"softprops","description":"self documentaion for your sinatra app's routes","archived":false,"fork":false,"pushed_at":"2013-03-10T19:51:41.000Z","size":105,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-05T00:36:53.848Z","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/softprops.png","metadata":{"files":{"readme":"README.md","changelog":null,"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-11-05T02:41:01.000Z","updated_at":"2024-12-18T03:12:16.000Z","dependencies_parsed_at":"2022-07-07T15:08:22.161Z","dependency_job_id":null,"html_url":"https://github.com/softprops/sinatra-doc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/softprops/sinatra-doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softprops%2Fsinatra-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softprops%2Fsinatra-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softprops%2Fsinatra-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softprops%2Fsinatra-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/softprops","download_url":"https://codeload.github.com/softprops/sinatra-doc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softprops%2Fsinatra-doc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30070082,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T01:03:42.280Z","status":"online","status_checked_at":"2026-03-04T02:00:07.464Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":"2024-10-11T12:40:57.672Z","updated_at":"2026-03-04T02:31:56.551Z","avatar_url":"https://github.com/softprops.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# sinatra-doc\n\nself documentaion for your [sinatra](\"http://sinatrarb.com\") app's routes\n\nNOTE: this project is now longer being actively maintained. I recommend you check out a more active (and probably more well-written) project [sinatra-docdsl](https://github.com/jillesvangurp/sinatra-docdsl)\n\n# install\n\n    \u003e gem install sinatra-doc \n\n# usage\n\nsee the reference implementation [app.rb](http://github.com/softprops/sinatra-doc/blob/master/app.rb)\n  \nbásicamente above any route you want documented, just add\n\n    doc \"some description\"\n\nor\n\n    doc \"some description\", { hash of params to param descriptions }\n  \nafterward a new route /doc will be added to your app that renders these documented routes \n\nan example  \n\n    \u003e your app.rb\n    \n    class App \u003c Sinatra::Base\n      register Sinatra::Doc\n      \n      doc \"gets a list of foos\"\n      get \"foos\" { ... }\n    \n      doc \"gets a specific foo\", { \n        :id =\u003e \"identifier for a given foo\"\n      }\n      get \"foos/:id\" { ... }\n    end\n    \n    \u003e GET /doc\n    \n    sinatra doc\n    \n    GET foos gets a list of foos\n    \n    GET foos/:id gets a specific foo\n      :id identifier for a given foo\n    \n# Props\n\nbased on an idea [@bmizerany](\"http://twitter.com/bmizerany\") proposed in a heroku talk in nyc\n\n# TODO\n\n  * rake sinatra::doc #=\u003e à la rails rake:routes \n  * clean up rendering of docs\n\n2009 softprops (doug tangren)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftprops%2Fsinatra-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoftprops%2Fsinatra-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftprops%2Fsinatra-doc/lists"}