{"id":25599262,"url":"https://github.com/thiagochirana/shorui","last_synced_at":"2025-06-14T18:39:18.199Z","repository":{"id":272207590,"uuid":"915828809","full_name":"thiagochirana/shorui","owner":"thiagochirana","description":"A gem that helps you easily generate README.md documentation from Rails routes","archived":false,"fork":false,"pushed_at":"2025-01-24T01:40:46.000Z","size":59,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T05:06:45.011Z","etag":null,"topics":["documentation","documentation-generator","rails","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thiagochirana.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-12T22:42:55.000Z","updated_at":"2025-01-24T01:40:49.000Z","dependencies_parsed_at":"2025-01-12T23:29:52.190Z","dependency_job_id":"b75e61cb-f44f-4a87-ada2-80e6e993a1bc","html_url":"https://github.com/thiagochirana/shorui","commit_stats":null,"previous_names":["thiagochirana/shorui"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thiagochirana%2Fshorui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thiagochirana%2Fshorui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thiagochirana%2Fshorui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thiagochirana%2Fshorui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thiagochirana","download_url":"https://codeload.github.com/thiagochirana/shorui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248665748,"owners_count":21142123,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["documentation","documentation-generator","rails","ruby"],"created_at":"2025-02-21T14:21:33.037Z","updated_at":"2025-04-13T05:06:56.071Z","avatar_url":"https://github.com/thiagochirana.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"![alt text](docs/ShoruiLogo.png)\n\n[![Gem Version](https://badge.fury.io/rb/shorui.svg)](https://badge.fury.io/rb/shorui)\n\nShorui is a Ruby gem that automatically generates API documentation by analyzing your Rails routes. It creates a clean, organized README.md file with detailed endpoint information.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'shorui'\n```\n\nAnd then execute:\n```bash\n$ bundle install\n```\n\nOr install it yourself as:\n```bash\n$ gem install shorui\n```\n\n## Usage\n\nShorui provides two Rake tasks:\n\n1. Generate full documentation including Rails routes:\n```bash\nrails shorui:generate\n```\n\n2. Generate documentation excluding Rails routes:\n```bash\nrails shorui:generate:no_rails_routes\n```\n\nThe gem will automatically:\n- Analyze your Rails routes\n- Extract controller and action information\n- Identify required and optional parameters\n- Generate a formatted README.md in your project root\n- Include HTTP verbs, paths, and parameter details\n\n## Output Format\n\nThe generated README.md will follow this structure:\n\n```markdown\n# Your Project Name API Documentation\n\n#### [HTTP_VERB] /path/to/endpoint\n- **Controller#Action:** `controller_name#action_name`\n- **Required Params:** `param1, param2` (if any)\n- **Optional Params:** `param1, param2` (if any)\n```\n\n\u003e You can see a better example [clicking here](https://github.com/thiagochirana/shorui/tree/main/example)\n## Features\n\n- Automatic route analysis\n- Clean and consistent documentation format\n- Support for all HTTP verbs\n- Parameter identification (required and optional)\n- Rails route filtering option\n- Proper handling of namespaced routes\n- Automatic project name formatting\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`.\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/thiagochirana/shorui. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](LICENSE.txt).\n\n## Code of Conduct\n\nEveryone interacting in the Shorui project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).\n\n## Origins\n\n\"Shorui\" (書類) means \"document\" in Japanese, reflecting the gem's purpose of automatic documentation generation.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthiagochirana%2Fshorui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthiagochirana%2Fshorui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthiagochirana%2Fshorui/lists"}