仕様を管理する

Apigee Edge は OpenAPI 仕様の保存場所となります。以降のセクションの説明に従って、OpenAPI 仕様を管理できます。

仕様リストを探索する

仕様リストにアクセスするには:

  1. apigee.com/edge にログインします。
  2. 組織またはパーソナル スペースを選択します。
    自分のパーソナル スペースに保存された仕様は、そのユーザーだけが使用できます。組織レベルで保存された仕様は、組織の他のメンバーも使用できます。
  3. サイド ナビゲーション バーメニューで、[Develop] > [Specs] を選択します。

仕様とフォルダの現在のリストが表示されます。

仕様リスト

上の図で強調表示されているように、仕様リストでは次の操作を実行できます。

新しい OpenAPI 仕様を作成する

新しい OpenAPI 仕様を作成するには:

  1. サイド ナビゲーション バーで、[Develop] > [Specs] をクリックします。
  2. [+ Spec] をクリックします。
  3. プルダウン メニューで、[New] をクリックします。
    仕様エディタが開きます。
  4. サンプル仕様を独自の OpenAPI 仕様の詳細に置き換えます。
    仕様エディタを使って仕様を作成するをご覧ください。

OpenAPI 仕様をインポートする

OpenAPI 仕様をインポートするには:

  1. サイド ナビゲーション バーで、[Develop] > [Specs] をクリックします。
  2. [+ Spec] をクリックします。
  3. プルダウン メニューで、次のオプションのいずれかをクリックします。
    • Import URL: URL から仕様をインポートします。プロンプトが表示されたら、名前と URL を指定します。
    • Import file: ローカル ディレクトリで仕様を参照します。
      仕様がリストに追加されます。
  4. 仕様の名前をクリックして、仕様エディタでそれを表示し、編集します。
    仕様エディタを使って仕様を作成するをご覧ください。

既存の OpenAPI 仕様を編集する

既存の OpenAPI 仕様を開くには:

  1. サイド ナビゲーション バーで、[Develop] > [Specs] をクリックします。
  2. 仕様リストで名前をクリックします。
  3. 仕様エディタで仕様を編集します。
    仕様エディタを使って仕様を作成するをご覧ください。

仕様リスト内の仕様から API プロキシを作成する

Apigee Edge では、仕様エディタで設計および保存した OpenAPI 仕様から API プロキシを作成できます。数回クリックするだけで、パス、パラメータ、条件付きフロー、ターゲット エンドポイントが自動生成された状態の API プロキシが Apigee Edge にできます。その後、OAuth セキュリティ、レート上限、キャッシュなどの機能を追加できます。

OpenAPI 仕様から API プロキシを作成した後で仕様が変更された場合は、実装された変更を反映するように API プロキシを手動で変更する必要があります。仕様を変更するとどうなるかをご覧ください。

仕様リスト内の OpenAPI 仕様から API プロキシを作成するには:

  1. サイド ナビゲーション バーメニューで、[Develop] > [Specs] を選択します。
  2. 必要に応じて、OpenAPI 仕様が格納されたフォルダに移動します。
  3. API プロキシの作成対象となる OpenAPI 仕様にカーソルを配置します。
  4. アイコンを展開する をクリックしてアクション メニューを展開します。
  5. [Generate API proxy] をクリックします。
    次の図に示すように [Build a Proxy] ウィザードが開き、OpenAPI 仕様の値を使って詳細ページが事前に入力されます。
    プロキシ ウィザードを構築する
  6. [Next] をクリックします。
  7. OpenAPI 仕様からの API プロキシの作成で説明されている手順に従って、[Build a Proxy] ウィザードの残りのページを操作します(ステップ 8 から始めてください)。

仕様の名前を変更する

仕様の名前を変更するには:

  1. サイド ナビゲーション バーメニューで、[Develop] > [Specs] を選択します。
  2. 必要に応じて、仕様が格納されたフォルダに移動します。
  3. 名前を変更する仕様にカーソルを合わせると、アクション メニューが表示されます。
  4. アイコンを展開する をクリックしてアクション メニューを展開します。
  5. [Rename] をクリックします。
  6. 仕様名を編集します。
  7. [Rename] をクリックして編集内容を保存するか、[Cancel] をクリックしてキャンセルします。

仕様をフォルダに移動する

さまざまな仕様をフォルダの中に整理すると、管理が容易になりセキュリティが向上します。仕様をフォルダに移動するには、フォルダを使用した仕様の整理をご覧ください。

仕様を削除する

仕様が不要または無効になったら、ファイルストアから削除できます。

仕様を削除するには:

  1. サイド ナビゲーション バーメニューで、[Develop] > [Specs] を選択します。
  2. 削除する仕様にカーソルを合わせると、アクション メニューが表示されます。
  3. アイコンを削除する をクリックします。
  4. [Delete] をクリックし、プロンプトで削除操作を確定します。
  5. 不要になった関連アーティファクトを削除します。