はじめに
今回は、API開発プラットフォーム「Apidog」を触ってみたのでご紹介します！
「Apidog」はAPIの設計/仕様書作成/モック作成/デバッグ/自動テスト/チーム共有などを
包括的に行えるAPI開発ツールで、Postmanより機能が豊富とのこと🐶
各機能の概要やPostmanとの比較は、以下記事を参照ください。
デスクトップ版とWeb版
パソコンに「デスクトップ版」をインストールして利用できますし、
インストールせずにブラウザから「Web版」を即利用することもできます。
デスクトップ版とWeb版で大きな機能差異はないようですが、
Web版でローカルのAPIを実行する場合はブラウザ拡張機能が必要な場合がありそうです。
サンプルプロジェクトのAPIを実行してみる
ログインして利用開始すると、「My Project」にサンプルのAPIが登録されていました。
そのため送信ボタンクリックで、API実行や応答受信をすぐに試せます！
自動テストのサンプルシナリオも登録されていて、実行後にテストレポートを確認できました。
見やすいですね！
コラボフローのREST APIを実行してみる
プロジェクトのインポート
コラボフロー REST APIの仕様は以下サイトに公開されており、
「openapi.yaml」のリンクをクリックすると仕様定義ファイルをダウンロードできます。
Apidogで新しいワークスペース（チーム）を作成し、
先程ダウンロードしたopenapi.yamlをファイル選択してインポートします。
環境（URL）情報のインポートはデフォルトOFFなので、
チェックボックスにチェックを入れて一緒にインポートしましょう。
以下の様に、コラボフロー REST APIのURLなどが設定されたプロジェクトが作成されます。
環境変数の設定
環境管理画面で、以下変数を設定します。
- サーバー（Base URL）内の「{instance}」を「{{instance}}」と二重括弧に編集します。
- 環境変数に「instance」を追加し、値にコラボフローのインスタンス名を設定します。
参考：Q. コラボフローのインスタンス名はどこで確認できますか？ – コラボフローサポート - 環境変数に「auth」を追加し、値に認証情報を設定します。
参考：認証について - コラボフローAPI
認証情報は「ログインID/apikey:発行されたAPIキー」をBASE64で符号化した文字列で、
設定画面では動的値（🪄スティック）アイコンをクリックして以下画面の様に入力します。
BASE64の指定方法が、少し分かり難かったです💦
認証情報の設定
認証情報は「ルートフォルダー」で共通設定し、各APIはこの設定を継承させます。
- タイプ：
API Key - 追加する場所：
Header - Key：
X-Collaboflow-Authorization - Value：
Basic {{auth}}※環境設定で追加した変数を指定します
ユーザー一覧取得APIを実行
Queryパラメータで「offset/limit/fields」を指定するか、左端のチェックを外し未指定にします。
（未編集だとoffset/limitが空文字列で送信され、数値でないためエラーになります💥）
送信ボタンをクリックすると・・・、無事に成功応答で情報を取得できました！！
おわりに
ヘルプセンターも日本語対応されており、分かりやすかったです。
1つのツールでAPIの設計、ドキュメント作成、モック作成、応答内容チェック、
CI/CD、負荷テスト、チーム共有まで行えるのはとても便利で、開発も効率化できそうです。
豊富な機能をもっと試して、各機能の詳細はまた別途記事にしたいと思います！
「ワークスタイルの未来を切り拓く」を理念に掲げ、リアルとデジタルの2つの働く場に向けた事業展開に留まらず、自社が率先して新しいワークスタイルに挑戦し、発信を行うことでワークスタイルの未来を切り拓いていきます。
Discussion