Let’s intuitively write API documentation with Swagger Editor in your Rails Project! 😊

Configureless and no DSL. 👍 But you can also configure.

Manage with yaml file instead of Ruby code.

Loosely coupled to your Rails project. 👍

So if you want to use another tool, you can port it right away. 😢

Generate api docment(OpenAPI) side only from Rails routing.

Provide rake tasks to management API Docment (OpenAPI) 🎉

$ bundle exec rake routes:oas:init
$ bundle exec rake routes:oas:docs
$ bundle exec rake routes:oas:ui
$ bundle exec rake routes:oas:editor
$ bundle exec rake routes:oas:monitor
$ bundle exec rake routes:oas:build
$ bundle exec rake routes:oas:clean
$ bundle exec rake routes:oas:analyze
$ bundle exec rake routes:oas:deploy

Happy Coding ❗️

Required Ruby Version

>= 3.2.0

Authors

yukihirop

Versions

  1. 0.6.0

    1. source

      1. 0.6.0 source October 31, 2025 (1.14 MB)
  2. 0.5.0

    1. source

      1. 0.5.0 source January 29, 2021 (46.5 KB)
  3. 0.4.1

    1. source

      1. 0.4.1 source August 24, 2020 (47.5 KB)
  4. 0.4.0

    1. source

      1. 0.4.0 source July 21, 2020 (48 KB)
  5. 0.3.4

    1. source

      1. 0.3.4 source July 10, 2020 (39.5 KB)
Show all versions (13 total)

Pushed by

yukihirop

SHA 256 checksum

← Previous version