はじめに VASILYでは、API開発を始める前に、Swaggerを用いてAPIドキュメントを作成しています。 APIドキュメントを作成した後、実際のAPIレスポンスを修正したがドキュメントの更新を忘れ、ドキュメントの定義と実際のレスポンスの間に差異が生じてしまうということがありました。 そこで、今回はcommitteeというgemを用いて、Swaggerで定義したAPIドキュメントと実際のAPIレスポンスとの差異を検知する方法をご紹介します。 committeeとは committeeは、実際のAPIリクエストやレスポンスがスキーマ定義にそっているかをチェックすることができるgemです。 Rackのミドルウェアとして動作します。 バージョン2.0からはJSON Schemaだけでなく、OpenAPI2.0(Swagger)もサポートされるようになったため今回はこちらのgemを使用します。
![Swaggerで定義したAPIドキュメントとAPIレスポンスの差異をなくす - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/55ea6a93b6c28d6fa090bc3d7b6b3efb070c45b2/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-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTk3MiZoPTM3OCZ0eHQ9U3dhZ2dlciVFMyU4MSVBNyVFNSVBRSU5QSVFNyVCRSVBOSVFMyU4MSU5NyVFMyU4MSU5RkFQSSVFMyU4MyU4OSVFMyU4MiVBRCVFMyU4MyVBNSVFMyU4MyVBMSVFMyU4MyVCMyVFMyU4MyU4OCVFMyU4MSVBOEFQSSVFMyU4MyVBQyVFMyU4MiVCOSVFMyU4MyU5RCVFMyU4MyVCMyVFMyU4MiVCOSVFMyU4MSVBRSVFNSVCNyVBRSVFNyU5NSVCMCVFMyU4MiU5MiVFMyU4MSVBQSVFMyU4MSU4RiVFMyU4MSU5OSZ0eHQtYWxpZ249bGVmdCUyQ3RvcCZ0eHQtY29sb3I9JTIzMjEyMTIxJnR4dC1mb250PUhpcmFnaW5vJTIwU2FucyUyMFc2JnR4dC1zaXplPTU2JnM9OThhMjJiMjE2YTQ4ZmVkOWJjYmMxNGJkNGM3NjFmODE%26mark-x%3D142%26mark-y%3D57%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZoPTc2Jnc9NzcwJnR4dD0lNDBybGxsbGhvJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9MzYmdHh0LWFsaWduPWxlZnQlMkN0b3Amcz0xZWFiOTZmMTA5ZTZlMjVhOGIyM2ZmZmE2YzE2NWYyZg%26blend-x%3D142%26blend-y%3D486%26blend-mode%3Dnormal%26s%3Db6f5a148ca8c4fb60d07be1aec2492a5)