railsのルーティングからOpenAPI(V3)ドキュメントを自動生成・管理するツールを作成し、4ヶ月間会社で運用した話(開発秘話もあるよ)RubyRailsGemswaggerOpenAPI はじめに railsを使ってAPIを開発している方で「 APIはあるけどドキュメントがない 」「 ドキュメントを書くための時間が確保しにくい 」こういう問題を抱えている人に役に立つかもしれない話です。 railsを使ってAPIを開発している会社でドキュメントも一緒に開発している会社って少ないと思います。 限られたリソースを上手く使ってスケジュール通りに作るために後回しにされる現実がある と思います。 この記事で紹介するツールを使えばOpenAPI(V3)形式のAPIドキュメントを書き始めるまでの環境がすぐに整います。 OpenAPIドキュメントの書き方に関してはあんまり言及しません。他の記事を参考
![railsのルーティングからOpenAPI(V3)ドキュメントを自動生成・管理するツールを作成し、4ヶ月間会社で運用した話(開発秘話もあるよ) - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/02523ae3426385f15ded00df95a9c1f3ae1e54f7/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-412672c5f0600ab9a64263b751f1bc81.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTk3MiZoPTM3OCZ0eHQ9cmFpbHMlRTMlODElQUUlRTMlODMlQUIlRTMlODMlQkMlRTMlODMlODYlRTMlODIlQTMlRTMlODMlQjMlRTMlODIlQjAlRTMlODElOEIlRTMlODIlODlPcGVuQVBJJTI4VjMlMjklRTMlODMlODklRTMlODIlQUQlRTMlODMlQTUlRTMlODMlQTElRTMlODMlQjMlRTMlODMlODglRTMlODIlOTIlRTglODclQUElRTUlOEIlOTUlRTclOTQlOUYlRTYlODglOTAlRTMlODMlQkIlRTclQUUlQTElRTclOTAlODYlRTMlODElOTklRTMlODIlOEIlRTMlODMlODQlRTMlODMlQkMlRTMlODMlQUIlRTMlODIlOTIlRTQlQkQlOUMlRTYlODglOTAlRTMlODElOTclRTMlODAlODE0JUUzJTgzJUI2JUU2JTlDJTg4JUU5JTk2JTkzJUU0JUJDJTlBJUU3JUE0JUJFJUUzJTgxJUE3JUU5JTgxJThCJUU3JTk0JUE4JUUyJTgwJUE2JnR4dC1hbGlnbj1sZWZ0JTJDdG9wJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9NTYmcz0zOTM1MDA0MDg5OWFjNDgwODI0MjQ2MmIzODkxMmEyMQ%26mark-x%3D142%26mark-y%3D57%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZoPTc2Jnc9NzcwJnR4dD0lNDB5dWtpaGlyb3AmdHh0LWNvbG9yPSUyMzIxMjEyMSZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT0zNiZ0eHQtYWxpZ249bGVmdCUyQ3RvcCZzPThjOTIxNDNjMjZlOTgxMGY4NGVhMTBjYmQwYzkyMDVk%26blend-x%3D142%26blend-y%3D486%26blend-mode%3Dnormal%26s%3D942e9444f1d62d2ae43a13bd1962c20f)