5分で分かるSwift OpenAPI Generatorの使い方 / How to use Swift OpenAPI Generator in 5 minutes

iOSDC Japan 2023 Day1 ルーキーズLT
2023-09-02 17:30-

#iosdc #a

https://fortee.jp/iosdc-japan-2023/proposal/1248c05d-aad8-40dd-804d-4a2a92f0d5c0

Transcript

1. Swift OpenAPI Generator Swift OpenAPI Generator の使い方 5分でわかる!!! 5分でわかる!!! L G T M し と こ ヮラ
2. (株)マンハッタンコード22卒 Swift ( / Kotlin / Flutter ) ビール好き ABOUT ME Naoki ばくぷー (• ﻌ • )｡
3. 既存のOpenAPIファイルを使って ソースを生成するツールでの 困りごと
4. 困りごと CLIでソースを生成し プロジェクトに入れ込む必要がある 1 OpenAPI形式のファイルの更新があるごとに CLIでソースを再生成してコミットをする必要がある 2
5. 持ち帰って 欲しいこと
6. Xcode内でコード生成が完結するので生成されたコードを入れ込む手間がなくなり より簡単にAPI通信ができる OpenAPI形式のファイル定義に沿って ビルド時にAPIリクエストのソースコードが生成される DerivedData内にコード生成されるためコミットが不要 持ち帰って欲しいこと SwiftOpenAPIGeneratorを使うと
7. Swift OpenAPI Generatorとは？ WWDC23で発表 Appleが提供しているSwiftパッケージプラグイン OpenAPI形式のファイルをインプットに HTTP呼び出しを実行するクライアントコード or サーバーコードを 生成してくれるツール
8. Swift OpenAPI Generatorの使い方 以下をSPMで追加すH 2 apple/swift-openapi-generato# 2 apple/swift-openapi-runtim) 2 apple/swift-openapi-urlsession
9. Swift OpenAPI Generatorの使い方 Build PhaseのRun Build Tool Plug-insにOpenAPIGeneratorを追加する
10. Swift OpenAPI Generatorの使い方 - ファイルの追加 インプットとなるファイルを2種類追加すU V OpenAPI形式のファイル：openapi.yaml or openapi.jsoP V 生成するコードを定義するファイル：openapi-generator-config.yaml ⚠️ ファイル名が決まっているので
 名前が違うと読み込まれない
11. Swift OpenAPI Generatorの使い方 ビルドす@ q 初回ビルド時にはpluginを信頼する必要がある DerivedData内に以下が生成され@ q Types.swif‡ q Client.swift OpenAPI形式のファイルが更新された時には
 ビルドをし直すだけで生成コードが更新される
12. Swift OpenAPI Generatorの使い方 - 実際にAPIを呼び出す importす6 4 OpenAPIRuntimC 4 OpenAPIURLSession
13. Swift OpenAPI Generatorの使い方 - 実際にAPIを呼び出す Client型を初期化す“ • 引数にサーバーURLとHTTPライブラリを指W • Servers.server1()は自動生成された関 • OpenAPI形式のファイルで定義したURLが返ってく“ • 今回はmockAPIのURL
14. Swift OpenAPI Generatorの使い方 - 実際にAPIを呼び出す リクエストとレスポンス用のソースコードを記載すE F responseはenumで定義されている
15. Swift OpenAPI Generatorの使い方 - 実際にAPIを呼び出す 関数を呼び出すと以下のようにjsonが返ってくる
16. Swift OpenAPI Generatorを使う上で気をつけること OpenAPI Docの各項目の
 descriptionを必ず記載する 1 各APIのoperationIdを設定する 2
17. Swift OpenAPI Generatorを使う上で気をつけること OpenAPI Docの各項目のdescriptionを必ず記載すT a Summaryにdescriptionの内容が反映されT a URL呼び出しで言うとserver1(7 a server1()と言う関数名については自動生成されたもの
18. Swift OpenAPI Generatorを使う上で気をつけること 各APIのoperationIdを設定すB A operationIdが関数名になり呼び出す時に使用されB A OpenAPIGeneratorを使う上で必須の項目
19. Swift OpenAPI Generatorを 使った時の 詰まりどころ
20. Swift OpenAPI Generatorを使った時の詰まりどころ  yamlのタイポに気付けず生成成功までに時間がかかっT  openapi-generator-config.yamp  Xcodeの該当行にエラー表示があるわけではない
21. Swift OpenAPI Generatorを使った時の詰まりどころ x yamlのタイポに気付けず生成成功までに時間がかかっe x OpenAPI形式のファイルを作る際にはGUIを使うと検知できP x Stoplight Studig x 設定ファイルについては良い方法があれば教えてください...
22. まとめ
23. SwiftOpenAPIGeneratorを使うと Xcode内でコード生成が完結するので
 生成されたコードを入れ込む手間がなくなる
 →より簡単にAPI通信ができる 1 OpenAPI形式のファイル定義に沿って
 ビルド時にAPIリクエストのソースコードが生成される →DerivedData内にコード生成されるため
 　コミットが不要 2
24. ご清聴ありがとうございました!! @naoki_mrmt 飲みのお誘いは マンハッタンコードHPの問い合わせ またはXのDMで受付中!!! iOSDC たのしも♡