自動生成されたhttpエンドポイントごとにカスタムミドルウェアを挿入したい話

https://gocon.jp/2024/sessions/21/

Transcript

1. © 2024 Finatext Holdings Ltd. 自動生成されたhttpエンドポイントごとに カスタムミドルウェアを挿入したい話 Go Conference 2024 reo(@_uhzz_)
2. © 2024 Finatext Holdings Ltd. 自己紹介 1 X:@_uhzz_ GitHub:uh-zz Goとサウナが好きです Reo Uehara / 株式会社Finatext
3. © 2024 Finatext Holdings Ltd. • 前提 • oapi-codegen の紹介 • issueで報告されているミドルウェア周りの話 • 独自の解決案を紹介 • まとめ アジェンダ 2
4. © 2024 Finatext Holdings Ltd. 前提 ルーティングエンジンは、弊社証券サービスで利用しているEchoを対象にします 3 https://techblog.finatext.com/technology-stack-for-reinventing-finance-as-a-service-4c76ea5ee6fc
5. © 2024 Finatext Holdings Ltd. 4 oapi-codegen の紹介
6. © 2024 Finatext Holdings Ltd. oapi-codegen の紹介 OpenAPI定義からGoコードを生成するツールです 5 コード生成 https://github.com/deepmap/oapi-codegen
7. © 2024 Finatext Holdings Ltd. oapi-codegen の紹介 インタフェースに沿って実装するだけ！ ルーティングはoapi-codegenが生成したコード側で、設定してくれる 6 インタフェースに沿ったサーバの実装を定義 生成されたルーティング関数に渡します
8. © 2024 Finatext Holdings Ltd. 7 issueで報告されているミドルウェア周りの話
9. © 2024 Finatext Holdings Ltd. issueで報告されているミドルウェア周りの話 エンドポイントごとにミドルウェアを差し込めない 上記の関数はルーティングのために生成されたボイラープレートコード 現状、エンドポイント毎にミドルウェアを渡す仕組みが用意されていない 8
10. © 2024 Finatext Holdings Ltd. 9 独自の解決案を紹介
11. © 2024 Finatext Holdings Ltd. 独自の解決案を紹介 解決したかった問題 10 やりたかったこと： 認証したあと、個別のエンドポイントに対して ミドルウェア処理を行いたい 課題： 認証ミドルウェアは個別に設定可能 →ただし認証以外のミドルウェアを個別に設定 する機構がない
12. © 2024 Finatext Holdings Ltd. 独自の解決案を紹介 このように解決した (OpenAPI→Goコード生成) 11 アプローチ： スキーマ駆動の精神で、OpenAPI側で制御 具体的には、APIごとにタグ付けを行う ポイント： 生成されるボイラープレートコードの echo.Contextにタグ情報をセットしている
13. © 2024 Finatext Holdings Ltd. 独自の解決案を紹介 このように解決した (Goアプリケーション側) 12 アプローチ： 独自のContextで、echo.Contextをラップ ポイント： echo.Contextにセットされたタグの取得と、 ミドルウェア呼び出しを独自Contextでラップ することで、コードの再利用性が向上します
14. © 2024 Finatext Holdings Ltd. 独自の解決案を紹介 このように解決した (Goアプリケーション側) 13 アプローチ： 独自のContextで、echo.Contextをラップ ポイント： echo.Contextにセットされたタグの取得と、 ミドルウェア呼び出しを独自Contextでラップ することで、コードの再利用性が向上します
15. © 2024 Finatext Holdings Ltd. 独自の解決案を紹介 14 このように解決した (独自のContext実装例) https://codehex.hateblo.jp/entry/echo-context を参考に実装
16. © 2024 Finatext Holdings Ltd. • oapi-codegenを使うと、 OpenAPI 準拠の REST API サーバを 生成することが可能 • 現状、生成されたエンドポイントごとに、カスタムミドルウェアを 割り当てられない問題がある ◦ issueで報告されている ◦ メンテナも反応しているのでサポートされるかも • ミドルウェア相当の処理を各エンドポイントで実行する方法を紹介 まとめ 15 詳細な実装サンプルはブログを書くので、ぜひフォローしてね👍