新しい APIを作成

APIは、特定のAPIまたはルートを表します。これは、ApidogでAPIを定義、テスト、文書化するための基本的な構成要素です。

Apidogは、API設計者が直感的にAPIを指定できるUIを提供しています。以下に例を示します。

APIを作成する

この例では、IDによってユーザー情報を照会するためのAPIを作成する方法を示します。

新しいAPIの作成: 新しいタブを開き、「New API」をクリックします。

リクエストパスの定義:
APIパスフィールドに/category/{id}と入力します。これにより、リクエストセクションの基礎が設定されます。

名前: Get category by id

パスパラメータ:

名前: id

タイプ: integer

例: 1

インターフェースが上記の画像と一致しない場合は、「設計優先」に切り替えてください。

レスポンス構造の定義:

Responsesセクションまでスクロールします。

OK(200)レスポンスで、+アイコンにカーソルを合わせてクリックし、「data」という子ノードを作成します。

スキーマ参照の使用:

dataノードにカーソルを合わせます。

タイプStringをクリックして「スキーマ参照」に変更します。

リストから「Category」（または関連するスキーマ）を選択します。

レスポンス例の追加:

Response Examplesセクションまでスクロールします。

Add Exampleをクリックします。

例データの生成:

例の名前を「Success」とします。

Auto-generateをクリックして、定義した構造に基づいてレスポンスデータを生成します。

OKをクリックして例を追加します。

APIを保存する: SaveをクリックしてAPI仕様を確定します。