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
- 0.6.0 October 31, 2025 (1.14 MB)
- 0.5.0 January 29, 2021 (46.5 KB)
- 0.4.1 August 24, 2020 (47.5 KB)
- 0.4.0 July 21, 2020 (48 KB)
- 0.3.4 July 10, 2020 (39.5 KB)