Apidogスタートアップガイド

組織内でApidogを使い始めるには、以下のタスクを進めてApidogチームを成功に導く準備をしましょう。まずは、チーム管理者や組織のITチームと協力して、Apidogの設定、セキュリティ、管理を行うことをお勧めします。その後、関連する設定を構成し、チームにメンバーを招待して役割を割り当て、プロジェクトに関連するリソースを作成することで、Apidogチームをセットアップできます。

Windows、Mac、Linux用のApidogデスクトップアプリをダウンロードしてインストールできます。また、Apidogエージェントを使ってウェブ上でApidogにアクセスすることも可能です。

ITチームとの協力

新しいソフトウェアを追加する手順を確立するために、ITチームに連絡を取りましょう。手順は組織によって異なりますが、以下のトピックが一般的です：

ITチームは、従業員のワークステーションにApidogをインストールできるようにデバイスポリシーに例外を追加する必要があるかもしれません。ApidogのダウンロードリンクをITチームに提供して、この例外を確立するのを手助けしましょう。

組織のネットワーク接続がプロキシの背後にある場合、Apidogを適切に設定する必要があるかもしれません。ITチームからプロキシ接続の詳細を取得し、Apidog内で設定してください。

すでにApidogにログインしている場合は、Apidogインターフェースの右上にある⚙設定 - プロキシオプションに移動してプロキシを設定できます。まだApidogにログインしていない場合は、Apidogクライアントアプリケーションのログイン画面の左下でプロキシ設定を構成できます。

組織がファイアウォールの背後で運用されている場合、ITチームはApidogのドメインの許可リストを設定する必要があるかもしれません。これにより、Apidogのデータがクラウドと同期され、すべての機能が期待通りに動作します。

Apidogのドメインには以下が含まれます：
*.apidog.com
*.apidog.io

Apidogチームのセットアップ

まず、組織内で誰がチーム管理者になるかを決める必要があります。チーム管理者はApidogアカウントを登録し、新しいチームを作成し、この新しいチームのチームオーナーになります。

チームオーナーには以下の権限があります：

チーム情報の変更

新しいプロジェクトの作成

メンバーの招待と削除

他のメンバーのチーム権限とプロジェクト権限の設定

サブスクリプションと支払いの管理

チームの移譲と解散

チームは複数のメンバーで構成され、さまざまなプロジェクトを管理できます。管理者は、特定のプロジェクト内でどのメンバーがどの権限を持つかを決定する権限を持っています。

Apidogの無料版では、チームは最大4人のメンバーを持つことができます。チームが4人を超える場合は、Apidogの有料プランにアップグレードする必要があります。

チームメンバーの管理

チームオーナーは、他のメンバーをチーム管理者として招待し、チーム内で追加の協力メンバーを招待および管理する責任を持たせることができます。

チーム管理者は、メールや招待リンクを通じて他のメンバーを招待してチームに参加させることができます。メンバーを招待する際、チーム内のプロジェクトに関するメンバーのデフォルト権限を設定できます。これらの権限には通常、管理者、編集者、読み取り専用、禁止が含まれます。

Apidogでは、チーム権限とプロジェクト権限は異なる承認レベルであることに注意が必要です。チーム権限は、チーム全体の管理に使用され、チーム設定、メンバー管理、全体的なチームガバナンスを含みます。チーム権限には、チームオーナー、チーム管理者、チームメンバー、ゲストなどの役割が含まれます。

一方、プロジェクト権限は、チーム内の個々のプロジェクトを管理するために特化されています。これらの権限は、プロジェクト設定、アクセス制御、プロジェクト範囲内での協力に関連する側面を管理します。プロジェクト権限には、管理者、編集者、読み取り専用、禁止などの役割が含まれ、特定のプロジェクト内でのチームメンバーの制御とアクセスレベルを決定します。

プロジェクトの作成

Apidogでは、各プロジェクトがOpenAPI Specificationに対応しています。API仕様に加えて、Apidogプロジェクトにはテストシナリオ、APIドキュメント、この仕様に関連する一連の独立したリクエスト、およびプロジェクト固有のさまざまな設定が含まれています。

Postmanに合わせて、Postman WorkspaceがApidogのチームに対応し、Postman CollectionがApidogのプロジェクトに対応します。

Apidogには、HTTPプロジェクトとgRPCプロジェクトの2種類のプロジェクトがあります。これらのプロジェクトタイプは異なる組織構造を持ち、混在させることはできません。

HTTPプロジェクト：HTTPプロジェクトでは、REST API、SOAP/WebService、GraphQL、WebSocket、Server-Sent Events (SSE)などの一般的なHTTPプロトコルAPIをデバッグできます。HTTPプロジェクトは、HTTP標準に準拠したさまざまなAPIをテストおよび操作するための多用途な環境を提供します。ユーザーは、HTTPプロジェクト設定内で多様なAPIタイプを探索およびデバッグできます。

gRPCプロジェクト：一方、gRPCプロジェクトは、gRPC APIのデバッグ専用に設計されています。

Apidogで新しいプロジェクトを作成する特権は、チームオーナーとチーム管理者のみが持っています。Apidogでプロジェクトを作成する際、管理者はプロジェクトタイプを選択し、このチーム内の他のチームメンバーのデフォルト権限を定義できます。

データ移行

Apidogは、十数種類以上の異なる形式でデータをインポートすることをサポートしており、さまざまな[一般的なAPI形式]をApidogに簡単にインポートできます。

Postmanからインポートする際、基本的なデータ構造の違いにより、PostmanリクエストはApidogではAPIケースとして認識され、ベースURLはApidogの環境サービスモジュールに保存されます。これは、Apidog内でのPostmanリクエストの通常の機能に影響を与えません。Postmanスクリプトは、Apidog内で直接実行でき、互換性の問題はありません。Postmanからの移行に関する詳細は、Apidog移行ブログを参照してください。

Apidog内のプロジェクトから別のApidogプロジェクトにデータを移行する必要がある場合は、設定メニューの「エクスポート」オプションを使用して、Apidog形式でデータをエクスポートします。その後、このファイルをターゲットプロジェクトにインポートします。Apidog形式は、包括的なプロジェクト情報をカプセル化しています。Apidogプロジェクト間のデータ移行にはOpenAPI形式を使用しないでください。API仕様以外のデータが失われる可能性があります。この方法は、Apidogプロジェクト間のプロジェクトデータの完全かつ正確な転送を保証します。

Apidog Global、Apidog Europe、およびApidogオンプレミスプラットフォーム間のデータは相互運用できず、Apidog形式へのエクスポート方法を使用して移行する必要があります。

初期プロジェクト設定

将来のチームコラボレーションを円滑にするために、プロジェクトの開始時に以下の設定を構成することをお勧めします。

[プロジェクト言語]：Apidogは「プロジェクト言語」と「インターフェース言語」を区別しています。プロジェクト言語は、プロジェクト内で作成されたコンテンツに使用される言語を指し、インターフェース言語はユーザーインターフェースに表示される言語です。プロジェクトを作成する際には、プロジェクト言語を選択することが重要です。プロジェクト内の一部の初期コンテンツは、この言語で初期化されます。

デフォルトレスポンステンプレート：会社が標準化されたレスポンス構造を持っている場合、それを「デフォルトレスポンステンプレート」として設定できます。これにより、新しく作成されたAPIがこのテンプレートをデフォルトのレスポンスとして持ち、プロジェクト全体で一貫性を保つことができます。

デフォルトレスポンステンプレートは、API - コンポーネント - デフォルトレスポンステンプレートで設定できます。

レスポンスコンポーネント：通常、プロジェクト内のさまざまなAPIのエラーレスポンスは類似しています（例：400、404）。これらの一般的なエラーレスポンスを「レスポンスコンポーネント」として構成し、デフォルトで有効にすることができます。この設定により、新しく作成されたAPIがこれらの事前構成されたレスポンスを持ち、レスポンス処理の効率と一貫性を促進します。

APIステータス：Apidogは、カスタマイズ可能なAPIステータスを提供しており、会社の特定の要件に基づいてこれらを調整できます。これらのステータスを使用して、プロジェクト内の各APIの進捗やステータスを分類および追跡できます。ワークフローやプロジェクト管理の実践に合わせて、どのAPIステータスを有効にし、構成するかを決定できます。

APIステータスは、設定 - 一般設定 - 機能設定 - API機能設定 - APIステータスで設定できます。

統合

Apidogは、さまざまな一般的なツールとの統合をサポートしており、API構築プロセスを大いに促進します。

CI/CD統合：Apidogはコマンドラインから実行でき、Jenkins、Github、GitlabなどのさまざまなCI/CDツールと統合できます。この統合により、CI/CDパイプライン内でのAPIテストとデプロイメントプロセスのシームレスな自動化が可能になります。

データベース統合：Apidogは、前処理および後処理でのSQLクエリの実行をサポートし、データベーステーブル構造からAPIスキーマを生成する機能を提供します。MySQL、SQL Server、Oracle、MongoDBなど、さまざまなデータベースが統合に対応しており、API開発とデータ管理の柔軟性を向上させます。

通知統合：Apidogは、APIの作成、変更、削除などのアクティビティをSlackやWebhooksをサポートする任意のツールに転送することを可能にします。この通知統合により、API開発活動に関するリアルタイムの更新とコラボレーションがチームやプラットフォーム間で確保されます。

Apidogでは、ワークフローを強化し、プラットフォームの機能を拡張するために、追加の外部ツール統合をさらに探索できます。Apidogの統合機能を活用することで、さまざまな外部ツールやサービスと簡単に接続し、API開発とコラボレーションを効率化できます。