「つなぎこみ」を自動化する

swagger-jsによる「APIドキュメントからのAPIクライアントの自動生成」によって、バックエンドとスムーズに連携する。

Transcript

1. 「つなぎこみ」を自動化する swagger-jsによるフロントエンドとバックエンドの連携
2. 自己紹介 張 たいよ （GitHub: @neutron63zf） 東京大学理学部物理学科 新4年 • ventus-inc ◦ JavaScript ( Vue.js / Nuxt.js ) ◦ Golang / Firebase • 東京大学五月祭常任委員会 ◦ AWS / Nginx / Docker ◦ Node.js ( Express )
3. 構成 • 背景 • swagger-jsの概要 • 実際につないでみる • メリット、デメリット • まとめ
4. 背景 「つなぎこみ」はめんどくさい • 「つなぎこみ」とは • シンプルな「つなぎこみ」 • 問題点１：コピペコードの量産 • 問題点2：仕様の追跡 • まとめ
5. 「つなぎこみ」とは 右側の様に、バックエンド APIに対してフロント エンドからリクエストを送ってデータを受け取る 処理を書くこと。 フロントエンドとバックエンドが分離したシステ ムだとほぼ必須。 XHR, $.ajax, superagent, axios, fetchなどい ろいろクライアントがある。 出典：https://jp.vuejs.org/v2/cookbook/using-axios-to-consume-apis.html
6. シンプルな「つなぎこみ」 前のスライドのようにviewに近い部分に書い てしまうこともあるが、素のライブラリをラップし て、関数として切り出しておくと複数の場所で 使う場合などで取り回しやすかったりする。 レスポンス形式はともかく、リクエスト形式に関 する知識が必要。
7. 問題点１：コピペコードの量産 エンドポイントの数だけ上のようなコードを書 かないといけない。 10-20個程度なら楽だが、ventusのwhooop! のようなサービスだとエンドポイントの数は 100個レベルになるため少ししんどい。 APIドキュメントを機械的に翻訳する人になっ てしまう。 （社内サービスとして作ったコードのリクエスト関数たち）
8. 問題点2：仕様の追跡 （ある程度は仕方ないことだが） APIのリクエス ト形式が変わると関数も書き換えないといけな い。 そして結構変更忘れが起きる。 APIドキュメントと実装が違っていてバグること がある。 （リクエスト形式に伴う変更の例）
9. まとめ • APIにリクエストを飛ばすのはほとんど避けて通れない • でも、複雑なアプリケーションだとエンドポイントごとに関数を用意するのは結構めんどくさい • しかも、APIの仕様を追跡してそれらを保守しないといけない →APIドキュメントがあっても、それをうまく活用できてない。 →APIドキュメントから自動で関数（APIクライアント）を生成できれば楽なんだけ どなあ...
10. swagger-jsの概要 swagger-jsとswagger-codegenの紹 介 • swagger-jsについて • swagger-codegenについて（おまけ）
11. swagger-jsについて APIドキュメンテーションツールとして有名な swaggerだが、結構いろいろな周辺ツールが ある。 その中の一つであるswagger-jsを使うと、 swaggerの形式に従ったAPIドキュメントから APIクライアントを自動で作ってくれる。 （GitHubのページ。 リポジトリ名はswagger-jsだが、名前はswagger client）
12. swagger-codegen について（おまけ） 他の言語やFW、たとえばTypeScriptやRails, Javaなどで同じことをしようとするとこれを使う ことになる。 また、swaggerのドキュメントから簡易的なスタ ブサーバーを立てることもできる。 ただし細かいカスタマイズには Javaが必要な ため少々書きづらい。自前でパーサーを書くと いう手もある。 （GitHubのページ。 使用可能な言語のリストがずらっと並ぶ。）
13. 実際につないでみる 具体的な実装 • インストール • swaggerドキュメントを読み込む • リクエストを飛ばす ◦ operationIdを知る ◦ パラメーターを指定する ◦ 実際にやってみる • カスタマイズする • その他
14. インストール npm, yarnでインストール可能 CDNでも使える （GitHubより）
15. swaggerドキュメントを 読み込む（1） 一番基本的な使い方は、「 swaggerで書かれ たAPIドキュメントをネット越しに読み込む」と いうもの。 APIドキュメントはjsonを返すエンドポイントで なくてはいけない。 APIクライアントはPromiseとして返ってくるの で、awaitすると便利。
16. swaggerドキュメントを 読み込む（2） 公式docsには書かれていないので少しトリッ キーだが、直接jsonをパースしたオブジェクト を渡して初期化することもできる。 ローカルでswaggerのファイルを管理したいと きなどは便利。
17. リクエストを飛ばす 一旦読み込んでしまえばあとは簡単なのだが、リクエストに必要な情報を 2つ知る必要がある。 • どのエンドポイントに、何のメソッドを使って飛ばすか（ operationId） • パラメーターは何か この2つを順番に解説していく。
18. operationIdを知る 「どのエンドポイントに、何のメソッドを使って飛 ばすか」をoperationIdとして把握する。（少し めんどい） swaggerのjsonに書かれている場合もある が、何も書かれていない場合は、「 post_pet」 のように、「${method}_${path}」のような名前 が自動で割り振られる。 pathのうち半角英数字でないものは全て「 _」 に置き換えられる。 （swagger petstoreでの例）
19. パラメーターを指定する POSTやGETなどのクエリパラメーターなどを swaggerをもとに調べる。 そのパラメーターがqueryなのか、path parameterなのか、bodyなのかなどは swaggerが自動で判別して入れてくれる（地味 に助かる。） （swagger petstoreの例）
20. 実際にやってみる 実際に2つを指定してリクエストを飛ばすスクリ プトは右のようになる。 baseUrlなどは全てswaggerに記述されてい いるものがデフォルトで使用される。 （swagger petstoreの例）
21. カスタマイズする 例えば、swaggerにbaseUrlが無かったり、リ クエストヘッダをいじりたい（例 ：multipart/form-dataにしたい）ときなどは、 リクエストを組み立てていじることが可能。 （リクエストをいじることも可能）
22. カスタマイズする 例えば、swaggerにbaseUrlが無かったり、リ クエストヘッダをいじりたい（例 ：multipart/form-dataにしたい）ときなどは、 リクエストを組み立てていじることが可能。 リクエストを組み立てるだけの 「buildRequest」メソッドと、送信するだけの 「http」メソッドがある。（いずれも staticメソッ ド） （リクエストをいじってから送信する）
23. その他 実際に使うときは、従来の「リクエストを送信する関 数を使う方式」も「operationIdとparameter」で送信 できるようにしておくと都合がいい。 （whooop!では、swagger-jsを拡張して、これらをプ ラグインできるようなクラスを使用している。） （再掲：従来の「リクエストを送信するだけの関数」）
24. メリット、デメリット 実際に開発で使ってみて思ったこと • メリット ◦ 実装コストの削減 ◦ APIリクエストのカプセル化 • デメリット ◦ swaggerに強く依存する ◦ カスタマイズが少しは必要
25. 実装コストの削減 swaggerを更新するだけでリクエストを飛ばせ るようになったので、だいぶ快適になった。 また、パラメーターが足りないときはリクエスト を組み立てる段階でエラーが出るので bad requestが減る。 operationIdもまとめて書いておけば補完が 効くし、素の関数を書くより頭を使わなくてい い。 （補完のための一覧。なくてもリクエストは飛ばせる。）
26. APIリクエストのカプセル化 リクエストのオブジェクトを簡単に作れるように なったので、いろいろな書き方ができるように なった。 whooop!ではnuxtを使っているが、「リクエス トの送信はページで、必要な情報（リクエスト） は各コンポーネントで組み立てる」という実装 で、DRYかつ、テストがしやすいようにしてい る。 （実装の例。 送信はページで、 リクエストの詳細は各コンポーネントが担当する。）
27. swaggerに強く依存する swaggerを読み込むという性質上、実際にエ ンドポイントがあっても、swaggerがなかった り、間違っていると送信できなかったりする。
28. カスタマイズが 少しは必要 複数の環境で同じswaggerを使っている場 合、baseUrlが同じになってしまうため、多少 のカスタマイズは避けられない。 他にも、ヘッダーが切り替わらなかったりする ので、そこも少しは実装しないといけない。 （再掲：ヘッダーやbaseUrlをいじったりする必要がある。）
29. まとめ 　 • APIへのリクエスト関数を書いて保守す るのはめんどくさい • swagger-jsを使うと、swaggerのAPIド キュメントからリクエストを（かなりの割合 で）自動で作れる • APIリクエストがカプセル化されていろん な書き方ができるようになる