OpenAPI を守るのは難しい

OOC 2024 当日参加LTの資料です
https://ooc.connpass.com/event/305241/

Transcript

1. OpenAPI を守るのは難しい Object-Oriented Conference 2024 LT うーたん
2. 自己紹介 • うーたん • 新卒サーバーサイドエンジニア ◦ 株式会社ゆめみ • 趣味 ◦ アニメを見ること • X ◦ @uutan1108 2 月刊I/O 3月号、4月号に 「プログラミング& 実行できるWEBアプリを手作り」 掲載されたので読んでね
3. 詳細はこちらのスライドを読んでください https://speakerdeck.com/kentaroutakeda/laravel-openapiniyoru-xin-kunai-sukimaqu-dong-kai-f 武田 憲太郎 さんのスライドです
4. 目次 - OpenAPI とは - OpenAPI の自動生成を使わず開発 - 自動化、コードに取り込ませて守らせる - 終わりに
5. OpenAPI とは
6. OpenAPI とは - API(application programming interface)の仕様をJSONやYAMLファ イルで記述できる - APIのエンドポイント、パラメータ、レスポンスなどの定義ができる - インタラクティブなドキュメントを生成できる - さまざまなプログラミング言語でAPIクライアントのコードを 自動生成できる OpenAPI仕様とは、使いやすい記述ツールをご紹介！ https://apidog.com/jp/blog/what-is-openapi/
7. OpenAPI とは - API(application programming interface)の仕様をJSONやYAMLファ イルで記述できる - APIのエンドポイント、パラメータ、レスポンスなどの定義ができる - インタラクティブなドキュメントを生成できる - さまざまなプログラミング言語でAPIクライアントのコードを 自動生成できる OpenAPI仕様とは、使いやすい記述ツールをご紹介！ https://apidog.com/jp/blog/what-is-openapi/
8. OpenAPI とは - API(application programming interface)の仕様をJSONやYAMLファ イルで記述できる - APIのエンドポイント、パラメータ、レスポンスなどの定義ができる - インタラクティブなドキュメントを生成できる - さまざまなプログラミング言語でAPIクライアントのコードを 自動生成できる OpenAPI仕様とは、使いやすい記述ツールをご紹介！ https://apidog.com/jp/blog/what-is-openapi/
9. OpenAPI から interface を自動生成できる
10. APIクライアントのコードを自動生成できる - 自動生成するツールに OpenAPI Generator がある - TypeScript のコードを OpenAPI Generator を使って生成 すると interface が生成される - API を利用するときに生成された interface を使う
11. OpenAPI (YAML) https://zenn.dev/overflow_offers/articles/20220620-openapi-generator
12. 自動生成
13. https://zenn.dev/overflow_offers/articles/20220620-openapi-generator TypeScript (interface)
14. OpenAPI (YAML) に従ってそれぞれ実装する A P I バックエンド フロントエンド OpenAPI を変更して実装も 変更する
15. OpenAPI (YAML) に従ってそれぞれ実装する A P I バックエンド フロントエンド 自動生成されたコードを使う 自動生成されたコードを使う
16. OpenAPI (YAML) に従ってそれぞれ実装する A P I バックエンド フロントエンド 自動生成されたコードを使う 自動生成されたコードを使う OpenAPI を信じてもらえる
17. フロントエンドもバックエンドも自動生成したコー ドを使えば... OpenAPI と実装に乖離がなくなるはず
18. OpenAPI の自動生成を使わず開発
19. OpenAPI で定義した仕様を信じている A P I バックエンド フロントエンド API の定義を実装するぞ API からのレスポンスを 受け取って処理するぞ
20. OpenAPI で定義した仕様を信じている A P I バックエンド フロントエンド スキーマは人間 が書く！
21. OpenAPI で定義した仕様を信じている A P I バックエンド フロントエンド OpenAPI から 自動生成はしない！
22. OpenAPI の自動生成を使わず開発を続ける
23. OpenAPI を変更しなくても、 実装に影響ないし... 実装を変更してから OpenAPI も変更してもらお
24. OpenAPI からコードを生成しないので、 仕様書のように変更されなくなる...
25. OpenAPI (YAML) に従ってそれぞれ実装する A P I バックエンド フロントエンド OpenAPI のメンテ追いつかん
26. OpenAPI で定義した仕様を守らなくなる A P I バックエンド フロントエンド レスポンスを知りたかったら 俺のコードを見ろ！
27. OpenAPI で定義した仕様を守らなくなる A P I バックエンド フロントエンド レスポンスを知りたかったら 俺のコードを見ろ！ OpenAPI の仕様は信じない...
28. 悲しい A P I バックエンド フロントエンド レスポンス知りたかったら 俺のコードを見ろ！ OpenAPI の仕様は信じない... 人力でメンテは無理だよ...
29. バックエンドの実装にフロントエンドが依存 A P I バックエンド フロントエンド レスポンスを知りたかったら 俺のコードを見ろ！ バックエンドのレスポンスを確認 するか...
30. インターフェース(API)ではなく バックエンドの実装にフロントエンドが 依存するようになる
31. なんでOpenAPI を守らなくなるのか...
32. 自動化、コードに取り込ませて守らせる
33. OpenAPI から自動生成させる A P I バックエンド フロントエンド OpenAPI から生成した interface に合わせて実装しろ！
34. 生成したインターフェースを守らせる A P I バックエンド フロントエンド OpenAPI を変更しないで実装のレ スポンスを変更させない！
35. バックエンドの実装を見なくても OpenAPI を見れば分かる A P I バックエンド フロントエンド OpenAPI をメンテするね メンテしないと実装できないからね
36. まとめ
37. 実装に合わせて OpenAPI を書くのではなく OpenAPI を変更してから実装に反映したい
38. 宣伝
40. 2024. 5.12 Sun 11:00 - 16:00
41. OOC 2024 のアフターイベントします
42. ご清聴ありがとうございました🙇 42