ソフトウェア開発実務者として、API デバッグは必須のスキルであり、Postman はこの点で優れた仕事をします。ただし、ソフトウェア開発プロセス全体のうち、API デバッグはその一部にすぎず、API ドキュメント定義、API モック、API 自動テストなど、Postman では完了できない、または効率的に完了できないことが数多くあります。 Apifox はこの問題を解決するために生まれました。
1. Swagger を使用して API ドキュメントを管理する
2. Postman デバッグ API などのツールを使用するMockJs
3. モック API データの使用法
4. API 自動テスト用の JMeter
データの一貫性を維持するのは非常に困難です異なるツール間での作業は難しく、非効率的です。そして、これは単なるワークロードの問題ではなく、より大きな問題は、複数のシステム間でデータの不整合があり、その結果、コラボレーションが非効率になり、問題が頻繁に発生し、開発者やテスターが惨めになるということです。
開発者は Swagger でドキュメントを定義した後、インターフェイスのデバッグ時に Postman に移動してドキュメントを再度定義する必要があります。フロントエンドでMockデータを開発する場合、MockJsで再度定義する必要があり、Mockルールも手動で設定する必要があります。テスターは JMeter にアクセスして、再度定義する必要があります。フロントエンドはMockJs Mockのデータを元に開発し、バックエンドはSwaggerで定義したインターフェースドキュメントを元に開発しましたが、どちらもテストに合格しており、すぐにオンライン化できると思いました。接続中に問題が発見されました: 開発プロセス中にインターフェイスが変更されました。Swagger は変更されましたが、MockJ は同時に変更されませんでした。バックエンドによって開発されたインターフェイスのデータ型とドキュメントには一貫性がないため、肉眼で問題を検出することが困難になります。同様に、JMeter で作成されたテスト ケースも、実際に実行するとさまざまな不一致が見つかります。時間が経てば経つほど、さまざまな矛盾が深刻になっていきます。
1. Apifox の位置づけ
Apifox = Postman Swagger Mock JMeter
Apifox は、API ドキュメント、API デバッグ、API モック、および API 自動テストのための統合コラボレーション プラットフォームです。
1 つのシステムと 1 つのデータを通じて、複数のシステム間のデータ同期の問題を解決します。インターフェースドキュメントが定義されている限り、インターフェースデバッグ、データモッキング、およびインターフェーステストは、再度定義することなく直接使用できます。インターフェース文書とインターフェース開発およびデバッグには同じツールが使用されます。インターフェースデバッグが完了した後は、インターフェース文書定義と完全に一致していることが保証されています。効率的、タイムリー、そして正確！
2. Apifox の目的
研究開発チームのあらゆる時間を節約しましょう!
3. Apifox 関数
インターフェイス設計: Apifox インターフェイス ドキュメントは、OpenApi 3.0 (旧 Swagger) および JSON スキーマ仕様に従っており、学習コストがゼロで非常に効率的な、非常に使いやすいビジュアル ドキュメント管理機能も提供します。また、インターフェイス ドキュメントのオンライン共有もサポートしています。データ モデル: インターフェイスの戻りデータ構造およびリクエスト パラメーターのデータ構造 (JSON および XML モードのみ) を定義するときに直接参照できる再利用可能なデータ構造。モデルの直接ネストされた参照、直接 JSON/XML インテリジェント インポートをサポートし、oneOf や allOf などの高度な組み合わせモードをサポートします。インターフェイスのデバッグ: Apifox は、環境変数、事前/事後スクリプト、Cookie/セッションのグローバル共有など、Postman が持つ機能を備えており、Postman よりも効率的で使いやすいです。インターフェースを実行した後、「ユースケースとして保存」ボタンをクリックすると、インターフェースのユースケースが生成され、パラメーターを入力せずに直接インターフェースのユースケースを実行できるため、非常に便利です。カスタム スクリプトは Postman 構文と 100% 互換性があり、JavaScript、Java、Python、php、js、BeanShell、go、shell、ruby、lua およびその他の言語コードの実行をサポートします。インターフェイスの使用例: 通常、インターフェイスには、正しいパラメータの使用例、間違ったパラメータの使用例、空のデータの使用例、異なるデータ状態の使用例など、複数の使用例があります。インターフェイス ユース ケースを実行すると、データの正確性が自動的に検証されるため、インターフェイス ユース ケースを使用してインターフェイスをデバッグすると非常に効率的です。インターフェイス データ モック: 組み込みの Mock.js ルール エンジンは、さまざまなデータをモックアウトするのに非常に便利で、データ構造を定義しながらモック ルールを作成できます。リクエストパラメータに基づいて異なるモックデータを返す「期待値」の追加をサポートします。最も重要なことは、Apifox は設定なしで非常にユーザーフレンドリーなデータをモックアウトできることです。これについては、この記事の後半で紹介します。データベース操作: データベース データの読み取りと、それをインターフェイス リクエスト パラメーターとして使用することをサポートします。インターフェイス要求が成功したかどうかを検証 (アサート) するためのデータベース データの読み取りをサポートします。インターフェイスの自動テスト: インターフェイスのコレクション テストを提供し、インターフェイス (またはインターフェイスの使用例) を選択することでテスト セットを迅速に作成できます。現在、インターフェース自動テストのためのさらに多くの機能が開発中ですので、ご期待ください。目標は、JMeter が基本的にすべての機能を備え、より使いやすくなるということです。クイック デバッグ: Postman に似たインターフェイス デバッグ方法。主な目的は、ドキュメントを必要としない一部のインターフェイスを一時的にデバッグすることです。事前にインターフェイスを定義しなくても、迅速にデバッグできます。コード生成: インターフェイスとデータ モデルの定義に基づいて、システムはインターフェイス要求コード、フロントエンド ビジネス コード、およびバックエンド ビジネス コードを自動的に生成します。チーム コラボレーション: Apifox はチーム コラボレーションのために生まれました。インターフェースはクラウド上でリアルタイムに同期して更新され、成熟したチーム/プロジェクト/メンバーの権利管理があらゆる種類の企業のニーズを満たします。
Apifox が研究開発チームの効率を向上させるためにデータ統合だけを行っていると考えているなら、それは間違いです。 Apifox は、開発者の効率を向上させるために多くの革新も行ってきました。
1. インターフェイスは「ユース ケース管理」をサポートします
通常、インターフェイスには、正しいユース ケース パラメーター、間違ったユース ケース データ、空のユース ケースなど、複数のユース ケースがあります。ユースケース、さまざまなデータステータスのユースケース。インターフェイスを定義するときにさまざまな状態に対してこれらのユースケースを定義し、インターフェイスのデバッグ時にそれらを直接実行すると、非常に効率的になります。
2.「データ モデル」の定義と参照
データ モデルは独立して定義でき、インターフェイスの定義時にデータ モデルを直接参照でき、データ モデルは相互に参照することもできます。同じデータ構造を 1 回定義するだけで、複数の場所で使用できます。変更する場合は 1 か所のみを変更するだけで済み、不整合を避けるために複数の場所がリアルタイムで更新されます。
3. デバッグ中の「自動検証」データ構造
Apifox デバッグ インターフェイスを使用すると、システムはインターフェイスの定義に従って返されたデータを自動的に検証します。データ構造が正しいかどうかを視覚的に確認したり、チェックするためのアサーション スクリプトを手動で作成したりする必要がなく、非常に効率的です。
#Apifox はデータ構造を自動的に検証します
4.「ビジュアル」設定アサーション
アサーションを設定:
7. 「ゼロ構成」モックは非常にユーザーフレンドリーなデータを生成します
最初に、Apifox と他の同様のツールの間でゼロ構成モックのデータ効果を比較するための画像を掲載します。
Apifox モック データの結果と同様のツールとの比較
Apifox は、インターフェイス定義のデータ構造とデータ型に基づいてモック ルールを自動的に生成します。 Apifox には、フィールド名とフィールドのデータ型に基づいて自動生成されたモック ルールをインテリジェントに最適化するインテリジェントなモック ルール ライブラリが組み込まれています。例: 名前に文字列 image が含まれる文字列タイプのフィールドは、画像アドレス URL を自動的にモックアウトします。文字列 time を含む文字列タイプのフィールドは、自動的に時間文字列をモックアウトします。文字列 city を含む文字列タイプのフィールドは、自動的にモックアウトします。都市名。 Apifox は、組み込みのルールに基づいて、写真、アバター、ユーザー名、携帯電話番号、Web サイトのアドレス、日付、時刻、タイムスタンプ、電子メール アドレス、都道府県、都市、住所、IP などのフィールドを自動的に識別し、それによってモックアウトすることができます。非常に使いやすいデータです。組み込みのモック ルールに加えて、ユーザーはさまざまな個人的なニーズに合わせてルール ライブラリをカスタマイズすることもできます。フィールド名をカスタムのモックルールと照合するための正規表現とワイルドカードの使用をサポートします。
8. オンライン インターフェイス ドキュメントの生成
Apifox プロジェクトは API ドキュメントをオンラインで「共有」できます。共有 API ドキュメントは公開に設定することも、パスワード アクセスを要求することもできます。外部チームとのコラボレーションも可能です。
エクスペリエンスアドレス: https://www.apifox.cn/apidoc/shared-ce387612-cfdb-478a-b604-b96d1dbc511b/http/5041285
#9. 自動コード生成
インターフェイス モデルの定義に従って、さまざまな言語/フレームワーク (TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、 Dart、C、C#、Rust など) ビジネス コード (モデル、コントローラー、単体テスト コードなど) およびインターフェイス リクエスト コード。 Apifox は現在、130 の言語とフレームワークの自動コード生成をサポートしています。
さらに重要なのは、カスタマイズされたコード テンプレートを使用して、チームのアーキテクチャ仕様に準拠したコードを生成し、さまざまな個人化されたニーズを満たすことができることです。
10. インポートとエクスポート
OpenApi (Swagger)、Markdown、Html などのデータ形式のエクスポートをサポート OpenApi 形式のデータをエクスポートできるため、OpenApi を使用できます( Swagger ) には、さまざまなインターフェース関連の作業を完了するための豊富なエコロジー ツールがあります。 OpenApi (Swagger)、Postman、apiDoc、HAR、RAML、RAP2、YApi、Eolinker、NEI、DOClever、ApiPost、Apizza、ShowDoc、API Blueprint、I/O Docs、WADL、Google Discovery、および古いデータ形式を容易にするその他のデータ形式のインポートをサポートします。プロジェクトは移行します。 OpenApi (Swagger)、apiDoc、および Apifox 形式のデータのスケジュールされた自動インポートをサポートします。
ブラウザ側でのApifoxの利用をサポートするWEB版Apifoxをリリースします。インターフェイスのパフォーマンス テストのサポート (JMeter と同様)。プラグイン マーケットをサポートしており、独自のプラグインを開発できます。 Apifox API を開くと、開発者が API を通じて Apifox 関数を呼び出せるようになります。 GraphQL、gRPC、WebSocket など、より多くのインターフェイス プロトコルをサポートします。オフライン使用のサポート: プロジェクトはオンラインで同期することも (チーム共同作業の場合)、ローカルにのみ保存することもできます (単一マシンでのオフライン使用の場合)。
インターフェイスのデバッグ
#オプションで複数のテーマを選択可能
![[Web フロントエンド] Node.js クイック スタート](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
