APIってなに？

例えば下記のように，ユーザがユーザIDを入力すると，そのユーザの性別を返す，といったような仕様のことです（超ざっくりです．入力はユーザじゃなくて他のDBの時もありますし）．

なぜ設計書を書くのか？

どういう値を受け取ってなにを返すのか，自分の頭が整理できます．
またこれから会社に入ってチームで開発するとき，チームメンバーで機能や仕様の共有のためにも設計書は必須です．逆に設計書を受け取って開発することもあります．

今回はSwaggerと呼ばれる，変数名とかをぶちこむだけでいい感じの設計書を勝手に作ってくれるエディタを使用しました．ブラウザ上で使えます．

こんな感じで左に書き込むと右におしゃれな設計書ができあがっていきます．すごい．

書き終えたらヘッダーのFile▼からSave as YAMLで保存しましょう．YAMLはそのまま「ヤムル」と読むそうです．
今回のアプリのYAMLはGitLabにあります．（GitLabでもYAMLがきれいに見えて感動してます）