PHPConference_LT_SwaggerでPHPとUnityエンジニアが仲良くなった話

PHPConference 2017のLTで発表したスライドになります。

PHPConference 2017
http://phpcon.php.gr.jp/2017/

発表資料中で紹介しているエンジニアブログについては下記リンクから参照お願いします。
Swaggerを使ってAPIの繋ぎ込みを楽にするための取り組み
https://tech.griphone.co.jp/2017/10/08/swagger/

Swagger UI × Amazon EC2 × Dockerで開発初期からAPIの繋ぎ込みを意識できる環境を構築してみたhttps://tech.griphone.co.jp/2017/10/08/swagger-mock-server/

Transcript

1. SwaggerでPHPとUnity エンジニアが仲良くなった話 株式会社グリフォン 仙道航 @phpcon2017 2017/10/08
2. ⾃⼰紹介 仙道 航 株式会社グリフォン サーバサイドエンジニア 2015年4⽉ 株式会社サイバーエージェント 新卒⼊社 2015年7⽉ ゲーム事業部 (SGE) 株式会社グリフォンへ配属 ソーシャルゲームの運⽤に約⼀年携わる 2016年3⽉ PHP × Unity の新規開発プロジェクトへジョイン 2017年10⽉
3. 開発あるある アプリやゲームの APIの繋ぎ込みは とても⼤変！
4. 弊社で過去に⾏われたAPIの繋ぎ込み サーバ エンジニア クライアント エンジニア ①APIドキュメントを書く
5. 弊社で過去に⾏われたAPIの繋ぎ込み サーバ エンジニア クライアント エンジニア ②ドキュメントを読みながら リクエスト,レスポンス部分 のクラス実装 ①APIドキュメントを書く
6. 弊社で過去に⾏われたAPIの繋ぎ込み サーバ エンジニア クライアント エンジニア ②ドキュメントを読みながら リクエスト,レスポンス部分 のクラス実装 ③~ API内容に更新や 不備があれば共有, 修正依頼 ①APIドキュメントを書く
7. 弊社で過去に⾏われたAPIの繋ぎ込みの問題 サーバ エンジニア クライアント エンジニア × 徐々に更新しなくなる！
8. 弊社で過去に⾏われたAPIの繋ぎ込みの問題 サーバ エンジニア クライアント エンジニア × 型や名前を⼿動で書くと ミスする → パースエラーの 原因に！ × 徐々に更新しなくなる！
9. 弊社で過去に⾏われたAPIの繋ぎ込みの問題 サーバ エンジニア クライアント エンジニア × 型や名前を⼿動で書くと ミスする → パースエラーの 原因に！ × ⼝頭によるその場しのぎ対応が 増えてドキュメントが置き去りに × 徐々に更新しなくなる！
10. これじゃ仲悪くなるよ・・・
11. 弊社での解決策
12. Swaggerとは？ 最近流⾏りのAPI開発ツールフレームワーク
13. Swaggerとは？ REST APIを記述するための仕様と 開発を後押しするツールを提供 弊社では3つのツールを利⽤している l Swagger Spec l Swagger UI l Swagger Codegen ଞʹ΋ͨ͘͞Μ͋ΔͷͰௐ΂ͯΈͯͶʂ 2.xܥ(stable)Λ ࢖ͬͯ·͢ʂ
14. Swagger Specとは？ YAML / JSON形式 で記述できるAPIの 設計図 [paths] エンドポイント, リク エスト, レスポンスの 定義 [definitions] データ型の定義
15. Swagger UIとは？ Swagger Specを基にした Web APIドキュメントを⽣成 リクエスト / レスポンスのサン プルを閲覧できる APIを叩くとサンプルレスポン スを返してくれる
16. Swagger Codegenとは？ Swagger Specから様々な⾔語のクライアント / サーバのコードを⾃動⽣成してくれる ⾃動⽣成されるコードの雛形にはmustacheという テンプレートエンジンが使⽤されている
17. 改善フロー サーバ エンジニア クライアント エンジニア ①Specを書く
18. 改善フロー サーバ エンジニア クライアント エンジニア ②⾃動⽣成 ①Specを書く ②⾃動⽣成 ②⾃動⽣成
19. 改善フロー サーバ エンジニア クライアント エンジニア ③~ API内容に更新や不備が あればSpecを修正, 修正依頼 ②⾃動⽣成 ①Specを書く ②⾃動⽣成 ②⾃動⽣成
20. 改善フローでのメリット サーバ エンジニア クライアント エンジニア ◦ ドキュメントもコードも 置き去りにならない！ ◦ 修正箇所が 集約された！ ◦ ⾔語の違い 以外は同じ定義の コードが⽣成 される！
21. 仲良しに！
22. 運⽤してみて気づいた注意点 Swagger Codegenのカスタマイズや⽣成物 に対してスクリプト処理による加⼯が必要な ケースもある Swagger Specの記述やファイル分割の規約 (機能ごとに作るなど)など決めたことが良い ことも多い ⼤量のデータを返すAPI(ゲームだとよくあ る)を定義する際、YAML/JSONで書くのは 結構つらい
23. 今⽇話せなかったこと https://tech.griphone.co.jp/2017/1 0/08/swagger https://tech.griphone.co.jp/2017/1 0/08/swagger-mock-server
24. まとめ Swaggerを利⽤してAPI繋ぎこみのつらさを 軽減する話をしました コードを混じえた具体的な取り組みはぜひ弊 社のエンジニアブログを参照してください！ https://tech.griphone.co.jp グリフォン エンジニアブログ で検索！
25. おしまい ご清聴 ありがとう ございました！