はじめに 私の職場では、WebAPIの仕様書をWordで書く習慣があったのですが、2018年頃にSwaggerで書くように切り替わったので、そのように変化した経緯を書きます。 何かの参考になれば幸いです。 ちなみに、こちらの記事と同じ職場です。 Wordな職場にMarkdownを定着させるためにやった4つのこと Swaggerとは? Swaggerとは、REST APIの仕様を定義するためのフォーマットです。その周辺技術も含めて、Swaggerと呼ばれます。以下の記事が非常に参考になりますので、詳細を知りたい方はご参照ください。 Swaggerの概要をまとめてみた。 Swagger 導入失敗 2016年頃のある日、上司から「世の中にはSwaggerというものがあるらしい。調べてもらえる?」と指示されました。 調べてみたところ、Swaggerがあれば、WebAPIのドキュメントサイトも作れる
![Wordな職場にSwaggerを定着させようとして失敗したけど結局定着した話 - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/8caf011f2924ed0b78a1c6edba1e677c9b48f12d/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-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTkxNiZ0eHQ9V29yZCVFMyU4MSVBQSVFOCU4MSVCNyVFNSVBMCVCNCVFMyU4MSVBQlN3YWdnZXIlRTMlODIlOTIlRTUlQUUlOUElRTclOUQlODAlRTMlODElOTUlRTMlODElOUIlRTMlODIlODglRTMlODElODYlRTMlODElQTglRTMlODElOTclRTMlODElQTYlRTUlQTQlQjElRTYlOTUlOTclRTMlODElOTclRTMlODElOUYlRTMlODElOTElRTMlODElQTklRTclQjUlOTAlRTUlQjElODAlRTUlQUUlOUElRTclOUQlODAlRTMlODElOTclRTMlODElOUYlRTglQTklQjEmdHh0LWNvbG9yPSUyMzIxMjEyMSZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT01NiZ0eHQtY2xpcD1lbGxpcHNpcyZ0eHQtYWxpZ249bGVmdCUyQ3RvcCZzPTFlMTdlZmQ3YTZjZDk2ZTcyY2U0NWIwODI4Y2M2YzYz%26mark-x%3D142%26mark-y%3D112%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTYxNiZ0eHQ9JTQwc2VndXImdHh0LWNvbG9yPSUyMzIxMjEyMSZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT0zNiZ0eHQtYWxpZ249bGVmdCUyQ3RvcCZzPTI2Y2I1ZGQyZjkwZDQ5ZThhZTJhMWM0MzIwYmRlM2Rl%26blend-x%3D142%26blend-y%3D491%26blend-mode%3Dnormal%26s%3D0c4621ce15cd3b27515efb442470ac7a)