API を登録する

Apigee X のドキュメントを表示中。
Apigee Edge のドキュメントを表示する。

API を登録すると、閲覧者が API リストで検出できるようになります。

API を登録

API を登録する

API を登録するには:

  1. Cloud コンソールで、[Apigee API ハブ] ページに移動します。

    [API ハブ] に移動

    デフォルトでは、[APIs] リストページが表示されます。

  2. [API を登録] をクリックします。[API を登録] ペインが開きます。
  3. 次の API の詳細を指定します。
    • ID: API リソースの識別子。ID に使用できるのは小文字、数字、ハイフンのみです。この ID はプロジェクト内で一意である必要があります。ID は 4~63 文字にする必要があります。API の登録後に ID を変更することはできません。たとえば、API リソース名 projects/my-project/locations/global/apis/my-api の場合、リソース ID は my-api です。
    • 名前: API 名を入力します。
    • 説明: API の説明を入力します。
    • Style:
      • スタイル: API の主なアーキテクチャ スタイルを選択します(API の構成に応じて、OpenAPIGraphQLAsyncAPI など)。
      • API の説明ドキュメント: 既存の説明ドキュメントがある場合は、[参照] をクリックしてアップロードします。アップロードできるファイルの個数は 1 つだけで、zip ファイル(最大 2 MB)もアップロードできます。リビジョンの追加と削除については、リビジョンの管理をご覧ください。
      • MIME タイプ: [MIME タイプ] を選択します。[MIME タイプ] は、API 説明ドキュメントを選択すると表示されます。[その他] を選択すると、MIME タイプを手動で指定できるテキスト フィールドが表示されます。
    • 現在のバージョン:
      • バージョン ID: API リソースの名前。バージョン ID 使用できるのは、小文字、数字、ハイフンのみです。バージョン ID はプロジェクト内で一意である必要があります。バージョン ID は 1~63 文字にする必要があります。API の登録後にバージョン ID を変更することはできません。
      • バージョン: 初期バージョンを入力します。
      • API ライフサイクル ステージ: リストからライフサイクル ステージを選択します。
    • 終了予定:
      • リストから [予定] を選択します。
      • [予定] が [最小日付] の場合は、[日付] を指定します。
      • [予定] が [確定した日付] の場合は、[日付] を指定します。
    • プロパティ:
      • システム分類
        • ターゲット ユーザー: API の対象ユーザー(利用者)を選択します。

        • チーム: API の作成を担当するチームを選択します。
        • ビジネス ユニット: API を担当するビジネス ユニットを選択します。
      • カスタム分類:
        • リストにある他のカスタム分類をすべて選択します。
    • メインの連絡先:
      • メインの連絡先メールアドレス: API に関する質問を送信するメインの連絡先メールアドレス
      • メインの連絡先の説明: メインの連絡先の説明
  4. [API を登録](または [キャンセル])をクリックします。

API 登録の詳細を編集する

API 登録の詳細を編集するには:

  1. Cloud コンソールで、[Apigee API ハブ] ページに移動します。

    [API ハブ] に移動

    デフォルトでは、[APIs] リストページが表示されます。

  2. API をクリックします。[API の概要] ページが開きます。
  3. [編集] をクリックします。
  4. 詳細を変更します。
  5. [保存] または [キャンセル] をクリックします。

API を削除する

API を削除すると、システムから削除されます。他者が API の履歴に関心を持つ可能性がある場合は、削除するのではなく、廃止または放棄済みのライフサイクル ステージの使用を検討してください。

API を削除するには

  1. Cloud コンソールで、[Apigee API ハブ] ページに移動します。

    [API ハブ] に移動

    デフォルトでは、[APIs] リストページが表示されます。

  2. API をクリックします。[API の概要] ページが開きます。
  3. [API を削除] をクリックします。
  4. 確認ダイアログが表示されます。API 名を入力し、[確認](または [キャンセル])をクリックします。

    API の削除の確定