チーム内でバックエンドとフロントエンドを担当分けることになり、 僕はフロント側を担当することになりました。 APIだけ先に用意してほしいな〜ってことで、試しにSwaggerを使ってみたら、だいぶ楽だった。 使い方調べてたら、いくつも方法があるみたいなので、 整理を含めて書き残しておこうと思い立った次第です。 今回はSpring Bootを利用してボトムアップアプローチで設計書を書き起こしてみます。 ボトムアップ・アプローチ:ソースコードから書き起こす ボトムアップアプローチというのは、ソースコードをベースにSwaggerを作成します。 ボトムアップアプローチの良いところは以下2点ですね。 ソースコードベースで設計書が出来上がるので、ドキュメントとコードが乖離しにくくなる 設計書作ってからソースコード書くという二度手間がなくなる 「手戻り発生したら困るじゃないですか〜」みたいな話もありますが
![SpringBootを使ってSwaggerに入門してみた](https://cdn-ak-scissors.b.st-hatena.com/image/square/a987fc7f97d2c06293e7895e6a978aab11b1cb93/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-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTkxNiZoPTMzNiZ0eHQ9U3ByaW5nQm9vdCVFMyU4MiU5MiVFNCVCRCVCRiVFMyU4MSVBMyVFMyU4MSVBNlN3YWdnZXIlRTMlODElQUIlRTUlODUlQTUlRTklOTYlODAlRTMlODElOTclRTMlODElQTYlRTMlODElQkYlRTMlODElOUYmdHh0LWNvbG9yPSUyMzIxMjEyMSZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT01NiZ0eHQtY2xpcD1lbGxpcHNpcyZ0eHQtYWxpZ249bGVmdCUyQ3RvcCZzPTE2NTczZjVhNTkyYzc0ZWY0MGVhNzliNmY1OGJmZjY1%26mark-x%3D142%26mark-y%3D112%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTYxNiZ0eHQ9JTQwaXN0LXMtZiZ0eHQtY29sb3I9JTIzMjEyMTIxJnR4dC1mb250PUhpcmFnaW5vJTIwU2FucyUyMFc2JnR4dC1zaXplPTM2JnR4dC1hbGlnbj1sZWZ0JTJDdG9wJnM9MzYyMDc1N2Y2OTY1YzhmMTM0MDgzMGMxNzQzMWIwMjY%26blend-x%3D142%26blend-y%3D491%26blend-mode%3Dnormal%26s%3Dfe1c352957c170cedeadc4d4d4fdc37e)