{"id":21766046,"url":"https://github.com/narazaka/swagger-dsl","last_synced_at":"2025-04-13T15:11:12.558Z","repository":{"id":59156951,"uuid":"225028187","full_name":"Narazaka/swagger-dsl","owner":"Narazaka","description":"Swagger (OpenAPI 3) DSL for Ruby","archived":false,"fork":false,"pushed_at":"2022-03-08T10:30:55.000Z","size":83,"stargazers_count":8,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-06T06:56:46.008Z","etag":null,"topics":["json-schema","openapi","rails","ruby","swagger"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"zlib","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Narazaka.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-30T14:59:26.000Z","updated_at":"2025-01-31T02:19:45.000Z","dependencies_parsed_at":"2022-09-13T20:03:59.661Z","dependency_job_id":null,"html_url":"https://github.com/Narazaka/swagger-dsl","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Narazaka%2Fswagger-dsl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Narazaka%2Fswagger-dsl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Narazaka%2Fswagger-dsl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Narazaka%2Fswagger-dsl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Narazaka","download_url":"https://codeload.github.com/Narazaka/swagger-dsl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248732485,"owners_count":21152852,"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":["json-schema","openapi","rails","ruby","swagger"],"created_at":"2024-11-26T13:14:59.005Z","updated_at":"2025-04-13T15:11:12.534Z","avatar_url":"https://github.com/Narazaka.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Swagger::DSL\n\nSwagger (OpenAPI 3) DSL\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'swagger-dsl'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install swagger-dsl\n\n## Usage\n\nsee also [swagger-serializer](https://github.com/Narazaka/swagger-serializer)\n\n```ruby\nclass BaseSerializer\n  extend Swagger::DSL::Serializer\nend\n\nclass UserSerializer \u003c BaseSerializer\n  swagger do\n    id :integer\n    name :string\n    age :integer, minimum: 18\n  end\nend\n\nclass ApplicationController\n  extend Swagger::DSL::RailsController\nend\n\nclass UsersController \u003c ApplicationController\n  swagger :update do\n    params do\n      path :id, schema: :integer\n      query do\n        safe schema: :boolean, required: false\n        redirect do\n          schema do\n            string!\n            format! \"url\"\n          end\n        end\n      end\n    end\n\n    body do\n      # name :string\n      # age :integer, minimum: 18\n      cref! UserSerializer # \"#/components/User\"\n    end\n\n    render 200, dsl: :jimmy do # another json schema dsl by \"jimmy\" gem\n      object do\n        string :status, enum: %w[ok], default: :ok\n        cref :user, UserSerializer\n        require all\n      end\n    end\n  end\n\n  def update\n    # some\n  end\nend\n\nSwagger::DSL.current[\"info\"] = {\n  \"title\" =\u003e \"my app\",\n  \"version\" =\u003e \"0.1.0\",\n}\n\nJSON.dump(Swagger::DSL.current)\n```\n\n### required default\n\nBody and response parameters are \"required\" default in default DSL.\n\nSo `params` are also default \"required\".\n\nIf you do not want it, `Swagger::DSL.current.config.default_required = false`.\n\n### If Rails eager_load = true\n\nRails controllers will be loaded before loading the routes when eager_load is enabled.\n\nSo set `Swagger::DSL.current.config.lazy_define_paths = true`, `reload_routes!` and `Swagger::DSL.current.define_paths!`\n\n```ruby\nif Rails.application.config.eager_load\n  Swagger::DSL.current.config.lazy_define_paths = true\n  Rails.application.config.after_initialize do\n    Rails.application.reload_routes!\n    Swagger::DSL.current.define_paths!\n    JSON.dump(Swagger::DSL.current)\n  end\nend\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/Narazaka/swagger-dsl.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnarazaka%2Fswagger-dsl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnarazaka%2Fswagger-dsl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnarazaka%2Fswagger-dsl/lists"}