{"id":16922745,"url":"https://github.com/unasuke/openapi3_definition_generator-rails","last_synced_at":"2025-04-11T16:52:11.328Z","repository":{"id":56886796,"uuid":"199619833","full_name":"unasuke/openapi3_definition_generator-rails","owner":"unasuke","description":"Generate minimum OpenAPI 3 definition YAML from config/routes.rb in your Rails application.","archived":false,"fork":false,"pushed_at":"2019-08-22T01:47:13.000Z","size":24,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T12:53:38.096Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/openapi3_definition_generator-rails","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/unasuke.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"MIT-LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-30T09:27:20.000Z","updated_at":"2024-10-04T14:53:53.000Z","dependencies_parsed_at":"2022-08-20T14:31:26.229Z","dependency_job_id":null,"html_url":"https://github.com/unasuke/openapi3_definition_generator-rails","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unasuke%2Fopenapi3_definition_generator-rails","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unasuke%2Fopenapi3_definition_generator-rails/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unasuke%2Fopenapi3_definition_generator-rails/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unasuke%2Fopenapi3_definition_generator-rails/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unasuke","download_url":"https://codeload.github.com/unasuke/openapi3_definition_generator-rails/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248443201,"owners_count":21104358,"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":[],"created_at":"2024-10-13T19:56:40.369Z","updated_at":"2025-04-11T16:52:11.307Z","avatar_url":"https://github.com/unasuke.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Openapi3DefinitionGenerator::Rails\n[![CircleCI](https://circleci.com/gh/unasuke/openapi3_definition_generator-rails.svg?style=svg)](https://circleci.com/gh/unasuke/openapi3_definition_generator-rails)\n\nGenerate minimum OpenAPI 3 definition YAML from `config/routes.rb` in your Rails application.\n\n:warning: This gem uses Rails private API so may be broken in future.\n\n## Usage\nHow to use my plugin.\n\n## Installation\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'openapi3_definition_generator-rails'\n```\n\nAnd then execute:\n\n```bash\n$ bin/rails openapi3_definition:generate_yaml\n```\n\n## example\nIn this `config/routes.rb` ...\n\n```ruby\nRails.application.routes.draw do\n  resources :users\n\n  get '/foo/:bar', to: 'foo#show'\nend\n```\n\ngenerates this yaml.\n\n```yaml\n---\nopenapi: 3.0.0\ninfo:\n  title: ''\n  description: ''\n  version: 0.1.0\npaths:\n  \"/users(.:format)\":\n    get:\n      summary: users\n      description: users#index\n      responses:\n    post:\n      summary: ''\n      description: users#create\n      responses:\n  \"/users/new(.:format)\":\n    get:\n      summary: new_user\n      description: users#new\n      responses:\n  \"/users/:id/edit(.:format)\":\n    get:\n      summary: edit_user\n      description: users#edit\n      responses:\n  \"/users/:id(.:format)\":\n    get:\n      summary: user\n      description: users#show\n      responses:\n    patch:\n      summary: ''\n      description: users#update\n      responses:\n    put:\n      summary: ''\n      description: users#update\n      responses:\n    delete:\n      summary: ''\n      description: users#destroy\n      responses:\n  \"/foo/:bar(.:format)\":\n    get:\n      summary: ''\n      description: foo#show\n      responses:\n```\n\n## Contributing\nContribution directions go here.\n\n## License\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funasuke%2Fopenapi3_definition_generator-rails","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funasuke%2Fopenapi3_definition_generator-rails","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funasuke%2Fopenapi3_definition_generator-rails/lists"}