デザイン
APIデザインは、主にAPIを重視するR&Dスタッフのニーズに対応し、リクエストパラメータと期待される応答を事前に定義することができます。インターフェースをデバッグすることが唯一の目標である場合は、デザインページをスキップして直接デバッグセクションに移動することができます。
基本的なインターフェース情報
デザインタブでは、インターフェースの開発状況、タグ、および拡張属性（プロジェクト設定で設定可能）を定義することができます。アイコンやテーブルなどの詳細な説明については、詳細な説明セクションの下でMarkdownを使用して編集することができます。
インターフェースのリクエストパラメータの定義
インターフェースのリクエストヘッダー、クエリ、およびその他の入力パラメータを視覚的に定義することができます。プロジェクト内の複数のインターフェースで共通のパラメータを共有する場合は、グローバルパラメータ機能を使用して、プロジェクト全体にこれらの入力を迅速に設定できます。
ヘッダー
一般的なヘッダー名に簡単にアクセスできるようにヘッダー入力パラメータを構成します。
- パラメータのタイプを設定するサポート
- アスタリスク *: パラメータが必須かどうかを示す
- パラメータ値: 入力パラメータの例示値
- パラメータの説明: パラメータの意味を説明する（クイックフィリングをサポートし、パラメータ説明ライブラリ機能について学ぶことができます）
クエリ
クエリ入力パラメータを構成します。
- パラメータのタイプを設定するサポート
- アスタリスク *: パラメータが必須かどうかを示す
- パラメータ値: 入力パラメータの例示値
- パラメータの説明: パラメータの意味を説明する（クイックフィリングをサポートし、パラメータ説明ライブラリ機能について学ぶことができます）
本文
複数のデータ形式をサポート：none、form-data、x-www-form-urlencoded、binary、msgpack、およびraw (json/xml/javascript/plain/html)。
- none: リクエストボディがない場合。
- form-data: ファイルのアップロードとコンテンツタイプの選択をサポートします。ファイルを含むフォームを送信する必要がある場合は、form-dataに切り替えてください。
- urlencode (x-www-form-urlencoded): フォームを送信する必要がある場合は、urlencodeに切り替えてください。
- binary: バイナリファイルをアップロードする必要がある場合
- msgpack
- raw: JSONオブジェクトやその他のオブジェクトを送信する必要がある場合は、対応するrawタイプに切り替えてください。
- raw (json/xml)形式は、jsonまたはxml形式の階層インターフェースパラメータのスキーマ設計をサポートします。
定義されたスキーマに基づいて値を生成します。
- raw (javascript/plain/html)は、パラメータ値を設計するためのソースコード編集をサポートします。
パス
{}または:を使用してインターフェースパスに変数を追加してRESTful APIデザインをサポートします。
認証
Bearerトークン、Basic認証、Digest認証、OAuth 1.0、Hawk認証、AWS Signature、NTLM認証（ベータ版）、Akamai EdgeGridなどの認証方法をサポート
応答例の定義
新しい応答
同じリクエスト内で、さまざまなシナリオで返される異なるデータ構造に対する複数の期待値を設定することができます。図に示すように、[新しい応答]をクリックすると、期待されるステータスコードを選択し、期待される名前を入力し、コンテンツ形式を選択して、[確認]をクリックして新しいものを作成できます。
スキーマ
JSON、XML、HTML、Binaryの4つのコンテンツタイプから選択できます。その中で、JSON/XML形式は、応答のスキーマを期待するための視覚的アプローチで設計できます（スキーマの使用方法について学ぶことができます）。
デザイン応答例の値
よく設計されたスキーマは、モック応答例の値を生成することもできます。
モックサーバー
インターフェースのリクエストパラメータと応答の期待値を定義したら、モックURLが自動的に生成され、フロントエンドとテストチームが早期に開発を開始できるようになります。
EchoAPIは、一致/不一致のトリガ条件の入力と使用される期待値の設定をサポートするインテリジェントモックサービスを提供します。インテリジェントな期待値を有効にした後、EchoAPIは、設定されたトリガ条件に従って事前に設定されたパラメータ判断ルールに一致し、条件が満たされると、事前に設定された期待値がアクティブ化されます。具体的な使用方法については、関連ドキュメントを参照してください。