Swift-OpenAPI-Generatorを研修課題に導入した話

サイバーエージェントではエンジニア新卒研修として3週間でSNSアプリを作るという課題があり、そこで導入した技術的チャレンジについて紹介します。

Transcript

1. Swift-OpenAPI-Generatorを 研修課題に導入してみた話
2. 目次 自己紹介 Swift-OpenAPI-Generator概要と導入 新卒研修紹介 運用のTips 使用に即して苦戦したこと まとめ
3. 自己紹介 👩🏼‍🚀 坂本泰成 / Taisei Sakamoto 株式会社 CyberAgent 2024年入社 TappleのiOSエンジニア _t12o_ developer-9
4. 本発表で目指すこと Swift-OpenAPI-Generatorの基本的な使い方のイメージがもて る 1. 導入によるメリデメを掴める 2.
5. エンジニア新卒研修課題とは
6. エンジニア新卒研修課題とは... 3週間でクライアント、サーバー、インフラ、MLDSの メンバーでSNSアプリケーションを作り上げること
7. チームでの共通認識
8. チームでの共通認識 最新技術をなるべく使って、 人が書かなくてもいいような反復的、機械的なコードは 自動生成をフルに活用しよう
9. Swift-OpenAPI-Genetorとは...
10. Swift-OpenAPI-Genetorとは... OpenAPI仕様からSwiftのAPIクライアントコードを 生成するツール
11. Swift-OpenAPI-Generatorで何が変わるのか APIの呼び出しに要する冗長なコード最低限に留める 1. ビルド毎にコードを生成してくれるため、APIドキュ メントと擬似的な同期状態になる 2. →リポジトリにコードをコミット不要になる
12. URLSessionとの比較
13. 導入について
14. 導入について 扱う目的によって導入する依存関係が違う swift-openapi-generator 本体であり、コードを生成するためのロジックが入っている swift-openapi-runtime generatorから生成されたコードから使用される共通の型や抽象化を提供す る。ClientMiddlewareなどのprotocolもここに定義されている swift-oepnapi-urlsession generatorから生成されたコードをHTTP操作をするためにURLSessionに紐付 けるトランスポーター
15. 導入について 他にもそれぞれの目的に応じたpackageがある
16. 導入後の生成手順 1.OpenAPIのドキュメント2つを追加する openapi-generator-config.yaml openapi.yaml 2.ビルドする 生成されたコードはDerivedDataに生成される
17. BaseURL エンドポイントのパス 生成時のメソッド名 返り値のパス ↑返り値(Greeting)の情報
21. 運用Tips
22. サーバーが発行するドキュメントの 最新バージョンを どうやって追従する？
23. Makefileに最新を取得するコマンドを用意する リポジトリの一時的にクローン 1. ファイルのコピー 2. 一時ディレクトリを削除 3.
24. 実際にアプリで使われたコードを見ながら 苦戦したことを紹介
25. 苦戦したことその① 生成されたコードの命名が不自然に冗長
26. 内部ではどうなっているか Returns a Swift-safe function name for the operation. Uses the `operationID` value in the OpenAPI operation, if one was specified. Otherwise, computes a unique name from the operation’s path and HTTP method. OperationDescription.swift OpenAPI オペレーションで `operationID` が 指定されている場合は、その値を使用します。 そうでない場合は、操作のパスと HTTP メソッドから一意な名 前を計算します。
27. 対策 サーバー側にoperationIdを 指定漏れがないようしてもらう get_sol_users_sol__lcub_user_id_rcub_ HTTPメソッド: get エンドポイント: /users/{user_id}
28. 苦戦したことその② multipart/form-dataに 対応する
32. 苦戦したことその③ Cognitoのリクエスト要件に答える HeaderにJWTを追加したい
33. 対応 HeaderFieldsに 付与したい 必要情報を与える HTTPField.Name
34. HTTPField.Nameには 代表的なヘッダー名が デフォルトで いくつか用意されている カスタムでヘッダーの追加も可能
35. まとめ
36. まとめ 自動生成とはいえ、ドキュメントとの一貫性があり理解しやすい まだ実装例が少ないので細かい例外には対応可能か不安 小規模かつ短期の開発には学習コストの方が高くなり利便性が掴 めない可能性がある 長期的にみると開発効率を上げることにはつながるため、部分的の導 入を試みる
37. ありがとうございました 🥳