このトピックでは、API の表示、削除、移動、クローン作成、一括操作の実行、および API コードの検索方法について説明します。
API の表示
DataWorks コンソールにログインします。上部ナビゲーションバーから対象のリージョンを選択します。左側ナビゲーションウィンドウで、 を選択します。表示されたページで、ドロップダウンリストから対象のワークスペースを選択し、DataService Studio へ移動 をクリックします。
サービス開発 ページで、対象 API が配置されている フォルダを展開します。
API の名前を右クリックし、詳細情報 を選択します。
説明API が公開済みの場合のみ、右クリックして 詳細情報 を選択できます。公開されていない場合は、API 構成ページの右側ペインで プロパティ をクリックして基本情報を確認してください。
API のクローン作成
API のコピーを作成し、ディレクトリツリー内の指定パスに保存できます。
サービス開発 ページで、対象 API が配置されている フォルダを展開します。
API の名前を右クリックし、クローン作成 を選択します。
API のクローン作成 ダイアログボックスで、パラメーターを設定します。
パラメーター
説明
API 名
中国語文字、英字、数字、アンダースコア (_) を含めることができます。先頭は中国語文字または英字である必要があります。長さは 4 文字以上 50 文字以内です。
API パス
API の保存先パス（例： /user）です。
API パスには英字、数字、アンダースコア (_ )、ハイフン (-) を含めることができます。先頭はスラッシュ (/) で始まり、長さは 200 文字以内です。
説明
クローン作成した API に対する説明を追加します。
宛先フォルダ
API を保存するフォルダです。
確認 をクリックします。
API の削除
公開されていない API のみ削除できます。公開済みの API を削除するには、事前に非公開化する必要があります。
API が公開済みの場合は、非公開化を行います（任意のステップ）。
API が公開されていない場合は、このステップをスキップできます。
サービス開発 ページで、上部メニューバーの サービス管理 をクリックします。API 管理 ページがデフォルトで表示されます。
公開済み API タブで、対象 API の [管理] 列から 非公開化 をクリックします。
API が非公開化された後、上部メニューバーの サービス開発 をクリックして、サービス開発 ページに戻ります。
サービス開発 ページで、対象 API が配置されている フォルダを展開します。
削除する API を右クリックし、[削除] を選択します。
重要この操作は元に戻せません。データセキュリティを確保するため、十分にご注意ください。
モバイル API
公開されていない API のみ移動できます。公開済みの API を移動するには、事前に非公開化する必要があります。
API が公開済みの場合は、非公開化を行います（任意のステップ）。
API が公開されていない場合は、このステップをスキップできます。
サービス開発 ページで、上部メニューバーの サービス管理 をクリックします。API 管理 ページがデフォルトで表示されます。
公開済み API タブで、対象 API の [管理] 列から 非公開化 をクリックします。
API が非公開化された後、上部メニューバーの サービス開発 をクリックして、サービス開発 ページに戻ります。
サービス開発 ページで、対象 API が配置されている フォルダを展開します。
移動する API を右クリックし、[移動] を選択します。
ファイルパスの変更 ダイアログボックスで、宛先フォルダ を選択し、確認 をクリックして API を移動します。
- 重要
API を移動すると、所属するグループが変更される場合があります。これにより、公開後の API の呼び出し URL が影響を受ける可能性があります。そのため、公開済み API の移動は十分にご注意ください。
API のバッチ操作
DataWorks では、サービスリソースグループの変更、API の提出、API の公開など、API に対するバッチ操作をサポートしています。この機能により、複数の API に対してリソースグループを迅速に切り替えたり、再公開したりできます。
サービス開発ページで、左側のディレクトリツリー上部にある
アイコンをクリックして、バッチ操作ページを開きます。
バッチ操作ページの上部で、ビジネスフロー や オーナー などの条件で API をフィルターできます。
フィルターされた一覧から、バッチ操作を実行する API を選択します。
API を選択した後、ページ下部から適用するバッチ操作を選択します。
以下に、バッチ操作と API ステータスの関係を示します：
バッチ操作
未公開 & 未提出
未公開 & 提出済み
公開済み & 未提出
公開済み & 提出済み
サービスリソースグループの変更
提出
再度提出することはできません。バージョン管理 で、右側ペインの API 編集ページから以前に提出したバージョンを破棄してください。
再度提出することはできません。バージョン管理 で、右側ペインの API 編集ページから以前に提出したバージョンを破棄してください。
公開
API を公開するには、事前に提出する必要があります。未提出の API の場合は、公開前に提出してください。
API を公開するには、事前に提出する必要があります。未提出の API の場合は、公開前に提出してください。
説明公開済み API のサービスリソースグループを変更した場合、変更を有効にするには、テスト、提出、再公開を再度実行する必要があります。
API コードによる検索
現在のワークスペースでコードエディタを使用して作成された API 内のコードを検索できます。
左側ナビゲーションウィンドウで、
アイコンをクリックしてコード検索ページを開きます。
検索ボックス右側の
アイコンをクリックして、フィルター条件を展開します。検索ボックスに、API 名、API パス、API の説明、テーブル名、フィールド名などのキーワードを入力できます。また、オーナー、ビジネスフロー、最終更新日時などの条件で検索結果を絞り込むこともできます。
検索結果を確認します。
検索条件に一致した結果が、検索ボックスの下に表示されます。結果には以下の情報が含まれます：
説明表示されるのは公開済み API のみです。
API 名：API 名をクリックすると、右側ペインにその API の構成ページが開きます。
コード内容：一致したキーワード、行番号、および周辺の簡易コンテキストが表示されます。一致したコード内容はコピー可能です。
基本情報：API ID、オーナー、ビジネスフロー、最終更新日時が表示されます。