最近Railsを使用してAPIを作成することが多いのですが、静的にドキュメントにリクエストパラメータが〇〇で、レスポンスが□□で...の用に書くのがたるくなってきたので、何か良いツールが無いかと探していた所、Swaggerというツールを見つけました。 Swaggerについて 公式サイト APIのパス、説明、リクエストパラメータ、レスポンス等を記述したJSONファイルを、Swaggerを使用することで、Web上で、インタラクティブにRestfulAPIの動作確認も行えるOSSです。 現行バージョンは2.0で、こちらについては、Web上でymlを記載するだけで生成してくれるエディターが存在します。 Railsで作成したAPIに対してSwaggerを使用する RailsでSwaggerのJSONを生成する場合、いくつかの方法があります。 grape-swaggerというgemでgrapeの記法で
![RailsのAPIをswaggerでドキュメント化してみる - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/ba1b4d53f4d9b6b37604704393957e0bedd9d6d1/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-9f5428127621718a910c8b63951390ad.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTkxNiZoPTMzNiZ0eHQ9UmFpbHMlRTMlODElQUVBUEklRTMlODIlOTJzd2FnZ2VyJUUzJTgxJUE3JUUzJTgzJTg5JUUzJTgyJUFEJUUzJTgzJUE1JUUzJTgzJUExJUUzJTgzJUIzJUUzJTgzJTg4JUU1JThDJTk2JUUzJTgxJTk3JUUzJTgxJUE2JUUzJTgxJUJGJUUzJTgyJThCJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9NTYmdHh0LWNsaXA9ZWxsaXBzaXMmdHh0LWFsaWduPWxlZnQlMkN0b3Amcz0zNmJiYTM2ZDc4MWJkZTVkMWZhOTMzN2I4OWExNWQ2Nw%26mark-x%3D142%26mark-y%3D112%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTYxNiZ0eHQ9JTQwdGFuaXNoLWtyJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9MzYmdHh0LWFsaWduPWxlZnQlMkN0b3Amcz1iNjIxZGM3NzllNTM3ZjQzYTVjOWYyNWJmMmY4MTEzOQ%26blend-x%3D142%26blend-y%3D491%26blend-mode%3Dnormal%26s%3D9a3ded76e64593b60e732fb6301e0d85)