モックサーバーを簡単準備　WireMockノススメ

-

 

こんにちは。
調子こいてTafs Adventカレンダー2023に2日目の投稿のMPPAです。

今日は開発によく必要とされるモックサーバーを準備しようという記事です。

👹お品書き👺
1.　本日のゴール
2.　モックサーバーってなに？
3.　環境準備
4.　WireMockを用意して起動してみよう
5.　WireMockに準備したAPIを呼んでみる
6.　さいごに


1.本日のゴール

本日のゴールはモックサーバーWireMockを起動して、設定を行ったAPIをコールしてみます。

2.モックサーバーってなに？

モックサーバーとは。。「スタブ(Stub)」っていうとしっくりくる人もいるでしょうか。色々調べてみましたがREST APIの値を疑似的に返すサーバーという定義でよさそうです。やろうと思えば普通にHTMLも返却できます。Apacheで設定ファイルいじってパスを再現するよりも私は楽かなと考えますが、これもきっと慣れでどっちでもOKかと。

自分なりにモックサーバーの使い道考えてみました。

  • 開発している自APIが他サーバーのAPIをコールしてる時のスタブとして。
  • WebUI開発時にサーバーサイドAPIのスタブとして。
  • 要件定義～基本設計にてユーザーに見せるためのWebUIの紙芝居をあたかも
    動作しているかのように見せるためのスタブとして。
  • 開発が遅い○○プロジェクトで、ダミーを返すインターフェースすら作られていない状況でのスタブとして（これは実現できないでしょう）
一番最初に書いた使い道がメインです。

3.環境準備（要リンク埋め込み）

今回も第一弾に引き続き、AWSを使って試してみます。
Dockerコンテナを利用するのが実用的ではありますが、
今回サーバーは。。。第一弾「RD Gatewayを使ってかっこよくクラウド上のWindowsVMに接続する」で作成したVMをそのまま使ってみます。
不安点とすれば今回題材とするWireMockがJavaベースなので、t2.microでちゃんと動いてくれるのかってところですが😓

正直、コンテナだろうがVMだろうが動けばいいと思います。

4.WireMockを用意して起動してみよう

まずはWireMock公式サイトからWireMockを入手。
Maven、Gradle、Dockerなど様々なテンプレートが用意されている中、
あえてStandaloneを選択します！
Standaloneならソースに組み込む必要もないので開発者じゃなくてもみんな使えますね！
（Dockerでもいいじゃんという突っ込みはなしで）



お気づきでしょうか。
jarファイルなんです。ってことはJavaが必要なんです。（さっきJavaベースって言ったし）
今日現在こなれたJava17をダウンロードしておきます。
　→　Java8 ランタイムでも大丈夫です。



VMを起動し、上２つのファイルをコピーしてJavaをインストール。
WireMockは適当な場所に置きましょう。
（サンプルではC:\apps\wiremockに配置しました）

なにもありませんが、とりあえず起動してみます。
起動コマンドは、、
java -jar wiremock-standalone-3.3.1.jar
(ファイル名にダウンロードしたjarファイルを指定）

なにもAPIが定義されてませんが、これで起動できることがわかりました。
※デフォルト設定ではt2.microでは耐えられなかった（スケールアップしてます）

5.WireMockに準備したAPIを呼んでみる

次にAPIのMockを定義してみます。
作業フォルダを決め、APIの定義フォルダを用意します。

＜作業フォルダ＞ーーmappings
　　　　　　　　└ー__files
mappingsmockの定義Jsonを保存するフォルダ
__filesレスポンスのメッセージをファイルから取得する際のファイル置き場

__filesは情報量の多いレスポンスを返却する場合や、WireMockのTemplateAPIを自在に使いこなして、レスポンスを生成する際に便利です。

まずはmappingsにMockのJsonファイルを配置します。
Jsonファイル名は任意です。

簡単なAPI定義を記述します。
{
  "request": {
    "method": "GET",
    "url": "/some/thing"
  },

  "response": {
    "status": 200,
    "body": "Hello, world!",
    "headers": {
        "Content-Type": "text/plain"
    }
  }
}
本家からHello,worldをパクってきました。
これをhello.jsonで配置します。
早速WireMockを起動します。
（起動している場合は再起動します）

ポートは8080
APIのURLは/some/thingで定義してありますので
http://localhost:8080/some/thing　になります。

RestClientにPostmanを使いました。
実行結果です。

無事に接続が完了しました。

6.さいごに

今回はWireMockの高度な利用方法は扱いませんでしたが、
このようなものがあるんだなと思っていただければ幸いです。

自分は業務の中で、リクエストデータに基づいてXMLファイルを生成し返却するmockを作成しました。もはやmock+ぐらいになってますが実装するよりははるかに楽にAPIを開発者に提供することができました。

極めたい方はこちらをベースにググってチャレンジしてみてください。

コメント

コメントを投稿

このブログの人気の投稿

ProxmoxでLet's Encryptを使用した証明書セットアップをやってみた

-
イメージ
■はじめに Proxmoxはデフォルトで自己証明書を使用しています。 このため、管理コンソールにアクセスすると「接続がプライベートではありません」といった画面が表示されます。 これの対処方法の一つとして、Let's Encryptを使用して簡単に証明書がセットアップできるとのことで、実際にやってみた内容を紹介したいと思います。 ■前提 ・自宅のProxmox環境（シングル構成）で実施 ・証明書取得時に使うのはDNS-01チャレンジ 　　HTTP-01チャレンジはWebサーバーを公開する必要があるためパス ・ハードル低めの（APIが使える）DNS Providerからドメインを取得して使用 　　下記の中からCloudflareをDNS Providerとして選択 　　　 How to use DNS API wiki ■手順概要 Cloudflareのアカウント作成～証明書反映まで、ということで実施内容としては下記となりました。 ＝＝＝＝＝ 1.Cloudflare アカウントの作成 2.Cloudflare ドメイン取得 3.Cloudflare アカウント APIトークンの作成 　　- ゾーン DNS を編集する権限を持つAPIトークンを作成 4.Cloudflare アカウント IDの取得 　　- ProxmoxのChallengeプラグインに投入するパラメータの取得 5.Proxmox ACME アカウントの追加 　　- 連絡先登録と利用規約への同意 6.Proxmox Challengeプラグインの追加 　　- Cloudflareのパラメータを投入 7.Proxmox ACME ドメインの追加 　　- 取得したいドメイン（FQDN）を設定 8.Proxmox 証明書の取得 　　- 証明書取得処理を手動開始 ＝＝＝＝＝ ■実施手順 1.Cloudflare アカウントの作成 Cloudflareのサイトにアクセスして画面右上の「ログイン」をクリックします。 　https://www.cloudflare.com/ja-jp/ ログイン画面に遷移するので、下部にある「サインインアップ」をクリックします。 登録するメールアドレスとパスワードを入力、ロボットでないこと確認にチェックを入れて「サインアップ」をクリックします。 アカウントが作成されます。 登録...
続きを読む

AIと共に「考える」エンジニアに！

-
イメージ
 ― ChatGPT時代に問われる「問いの力」と文章力 ― はじめに ChatGPTをはじめとする 生成AI が普及しはじめてから、もう2年近くが経ちました。   リリース当初は「すごい技術だな」と遠目から眺めている空気でしたが、今では多くの人がAIに触れる機会を持つようになりました。    我々 ITエンジニアとして 、アプローチはどうすべきか？何が必要か？について考えてみます。 AI利用の現状 まだAIを使い始めたばかりだったり、上手く使えてない人は、「このエラーを解決して」「この機能を実装して」と 指示を出すだけ になっているようです。   あるいは、「〇〇とは？」を丸ごとAIに聞いて解説してもらうケースも見られます。　便利ですが、それだと Google検索 と同じレベルに留まっていると感じます。 AIの本当の価値 私は、AIは 単なるコード生成ツールでも、Googleの上位互換でもない と考えています。   むしろ、使い方を間違えると取り残されていく可能性があります。  AIが本当に得意なのは、与えた問いに沿って 思考の幅を広げ、情報を整理すること です。   つまり、AIを活かすには、 問いを設計する力 が不可欠なのです。 問いを設計する力はAI以前からのビジネススキル 実は、問いを設計する力は、AIが登場する以前から、私たちエンジニアが日常的に使ってきたスキルです。   例えば、プロジェクトの課題を整理したり、仕様の確認事項を明確化したり、メールでの問い合わせの内容を意図通りに伝えたりなど...　いずれも、 相手や状況に応じて適切に問いを設計する力 がベースになっていました。   AIは文章やアイデアを生成してくれますが、 何を考えるべきかは教えてくれません 。だからこそ、この問いを設計する力がAI時代でも重要になるのです。 コンテキストエンジニアリング さらに最近は、単なるプロンプトの工夫（プロンプトエンジニアリング）だけでなく、文脈や前提を整理して問いを設計する「 コンテキストエンジニアリング 」が注目されています。   コンテキストエンジニアリングとは、単に「良いプロンプト...
続きを読む

ルーティングって何で必要で、何してるの？を React Routerで理解する

-
イメージ
はじめに フロントエンド開発が、正直苦手でした。 でも今回のプロジェクトでReactを触ることになり、「せっかくなら苦手意識を克服したい」と一念発起。 開発は終わりましたが、学習は継続しています。 Reactには多くの要素がありますが、今回はルーティングに絞ります。 バージョンの違いで書き方が変わり対応に戸惑ったこともあり、基本から振り返りつつ理解していった流れを記事にしたいと思います。 そもそもルーティングって何のために必要なの？ まず基礎の基礎になりますが、URL、ブラウザ、SPAの観点から振り返ります。 URLとは？ Uniform Resource Locator（統一資源位置指定子）の略語で、要するに「 インターネット上のモノの住所 」です。 https://example.com/products.html このようなURLの場合、ブラウザは、 URLを見る→( products.html というファイルが欲しいのだと解釈) サーバーにリクエストを送る HTMLファイル( products.html )をダウンロードして表示する つまり、URLは「どのファイルを取得するか」を指定する住所のようなものです。 ブラウザはURLで何をしているのか？ ブラウザにとってURLは「ページの識別子」です。 ブラウザは、URLをキーにして、いろんな機能を実現しています。      1. 履歴管理           URLが変わるたびに履歴に記録           「戻る」ボタンを押すと、履歴から1つ前のURLを取り出して、そのページに戻る           「進む」ボタンも同じ仕組み      2. ブックマーク           URLを保存することで、「このページ」を記憶           後でそのURLを開けば、同じページが表示される       3. URL共有...
続きを読む