5分で作るモックサーバー

DroidKaigi.collect { #5@Nagoya } の 5分LTで発表しました

1. 5分で作るモックサーバー DroidKaigi.collect { #5@Nagoya } satsukies
2. 自己紹介 • @satsukies （さつき） ◦ twitter / github • 前職: CyberAgent / ABEMA ◦ Androidアプリエンジニア • 現職: 株式会社DeployGate ◦ Androidアプリエンジニア ◦ フロントエンド/バックエンドもやってます
3. こういうこと、ありませんか • API繋ぎこみしたい！！ ◦ だけど、バックエンドも同時開発進行中ですぐにできない...！ • エッジケースとか デバッグしたい！！ ◦ 任意 レスポンスをアプリに受け取らせてみたい ◦ だけど正攻法だと思ったよりも大変かも...！
4. goでサーバー立てれ 意外とサクッといけるかも？
5. • OkHttp + RetrofitでAPI呼び出し 実装をしているAndroid App • インターネットに繋がっているPC ◦ 今回 MacOS環境で検証しています • ちょっと試してみたいと思える心 必要なも
6. 1. 開発環境を整えよう まず golangでコードがかける環境を用意しましょう すでにHomebrewを導入していれ 以下 1行実行でOK VS CodeやIntelliJ GoLandなど IDEがあるとちょっと楽 $ brew install go
7. 2. go環境 構築 まず 作業用 ディレクトリを用意して移動 $ mkdir mock-server $ cd /path/to/mock-server
8. 2. go環境 構築 go moduleを新規作成して、必要なファイルを生成しておきます $ go mod init mock-server go: creating new go.mod: module echo-server $ touch main.go response.json
9. $ ls go.mod main.go response.json 2. go環境 構築 ここまで作業すると、3つ ファイルが存在する状態になる ずです
10. 3. 返したいレスポンスをJSONファイルに記述 生成しておいたresponse.jsonにJSONを記述する // response.json { "id": 12345, "message": "This message is send by mock-server" }
11. 4. main.goにサーバー実装を記述 net/httpパッケージを使うと、とっても簡単に実装できます // main.go func main() { http.HandleFunc("/", handleRequest) http.ListenAndServe(":8080", nil) }
12. 4. main.goにサーバー実装を記述 JSONファイルを読み出して、中身をそ ままWriteしちゃいます // main.go func handleRequest(w http.ResponseWriter, r *http.Request) { byteArray, _ := ioutil.ReadFile("response.json") w.Header().Set("Content-Type", "application/json; charset=utf-8") w.Write(byteArray) }
13. JSONファイルを読み出して、中身をそ ままWriteしちゃいます package main import ( "io/ioutil" "net/http" ) func main() { http.HandleFunc("/", handleRequest) http.ListenAndServe(":8080", nil) } func handleRequest(w http.ResponseWriter, r *http.Request) { byteArray, _ := ioutil.ReadFile("response.json") w.Header().Set("Content-Type", "application/json; charset=utf-8") w.Write(byteArray) }
14. 5. 実際に動かしてみる go アプリケーション 動かす も簡単 $ go run main.go
15. 5. 実際に動かしてみる localhost:8080 にアクセスすると....
16. 6. ngrokを使って外部公開しよう ngrokというサービスを使うと、手元 環境を簡単に公開できます https://ngrok.com/
17. 6. ngrokを使って外部公開しよう ngrok インストールもHomebrew経由で簡単にできます $ brew install ngrok // token追加 $ ngrok config add-authtoken {your_auth_token}
18. 6. ngrokを使って外部公開しよう WebからSignUp後に提供されるコマンドを使ってログインすると使える $ brew install ngrok // token追加 $ ngrok config add-authtoken {your_auth_token}
19. 6. ngrokを使って外部公開しよう ngrok http {port} で起動できます $ ngrok http 8080
20. 7. Android Appを修正 Retrofit annotationに 相対/絶対パス以外に完全なURLも渡せる（！）
21. 7. Android Appを修正 Retrofit annotationに 相対/絶対パス以外に完全なURLも渡せる A relative or absolute path, or full URL of the endpoint.
22. 7. Android Appを修正 Retrofit annotationに 相対/絶対パス以外に完全なURLも渡せる @GET("/hoge") override suspend fun hoge(): HogeResponse { … } @GET("https://sample.com/foo") override suspend fun foo(): FooResponse { … }
23. 7. Android Appを修正 Retrofit annotationに渡しているAPI pathをngrok URLで置き換える // before @GET("/hoge") override suspend fun hoge(): HogeResponse { … }
24. 7. Android Appを修正 Retrofit annotationに渡しているAPI pathをngrok URLで置き換える // after @GET(“https://xxxx-yy-zzz.ngrok-free.app”) override suspend fun hoge(): HogeResponse { … }
25. 超簡易的なモックサーバが これで動かせます🎉
26. まとめ • Retrofitで呼び出し先を指定する方法 相対パスだけで ない ◦ 絶対パス、完全URLも使える • Goを使って簡易的なモックサーバーがサクッと作れる ◦ 複雑で ない用途であれ 扱いやすいかも？！ • ngrokを活用することで簡単に外部公開できる ◦ あくまでテスト用途にしておき、重要なデータ 扱わない ◦ 有料プランで固定 URLやIP制限などもできる