Protocol Buffers で Web APIのスキーマ駆動開発がしたい

Transcript

1. Protocol Buffers で Web APIの スキーマ駆動開発がしたい (若手)エンジニアもくもく会 vol.19 @ビザスク authored by t0yohei
2. Web API って • HTTP(S) のインターフェースで提供される API • SSKDs(Small Set of Known Developers) ◦ Google Map の Geo API など • LSKDs(Large Set of Unknown Developers) ◦ サービス内でフロントエンドサーバーとバックエンドサーバーがやり取 りするための API など • REST, SOAP, gRPC, GraphQL などがある
3. スキーマ駆動開発って？
4. Web API の振る舞いの詳細を先に 決めて、 開発を進めていく手法のこと
5. こんなことありませんか？ • フロントエンドの開発を進めたいけど、サーバーサイドからどんな json が 返ってくるかわからない • あるいは、予想してたのと違う json が返ってきた
6. 解決方法: スキーマ駆動で開発する • APIを作る人・使う人が一緒にどういう API を作るのかを一緒に決めておく • フォーマットとしては、 Swagger(OpenAPI) など • https://editor.swagger.io/
7. 問題 • API の実装に変更があった時、ドキュメントがそれに合わせてメンテされる ことが保証できない • その結果、ドキュメントが正しいかわからなくなる • Swagger あんまり見やすくない(解釈)
8. 我々が欲しいものは？ • 定義したスキーマを元に、クライアント・サーバーで使用するコードを自動 生成してくれるもの • 可読性が高いもの
9. Protocol Buffers(protobuf)
10. Protocol Buffers(protobuf) って？ • Google が開発してオープンソース化したスキーマ定義言語 • gRPCでよく使われている • proto ファイルに実装した定義を元に、コードの自動生成が可能 • 読みやすい • 今さらProtocol Buffersと、手に馴染む道具の話 • Web API に秩序を与える Protocol Buffers / Protocol Buffers for Web API
11. protobuf を使うとどうなるのか • API の振る舞いを proto ファイルに定義 • サーバーサイド・フロントエンドの実装で基盤となるコードを自動生成 • 詳細な実装を追加 • 実装を変更する場合は proto ファイルを修正 • proto ファイルが仕様書になる
12. ちゃんと実装しました(まだ途中だけ ど)
13. 作成したもの TODO リスト スキーマ定義: protobuf バックエンド: rails フロントエンド : nuxt.js with TypeScript
14. 直接コードを見てみる https://github.com/t0yohei/rails-nuxt-protobuf-todo
15. 何が嬉しいか • スキーマ駆動で開発することができる • APIの修正時にドキュメント修正がいらない(実装が仕様になるので) • 静的言語だと、通信で受け取ったデータを parse した瞬間に型付けされる