OpenAPI 仕様へのエクスポート

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:1分
  • REST API を OpenAPI 仕様としてエクスポートして、別の Web サービスツールにインポートします。

    始める前に

    必要なロール:web_service_admin、rest_api_explorer、または admin

    手順

    1. 移動先 すべて > System Web Services > REST > REST API エクスプローラー.
    2. エクスポートする API を選択します。
      たとえば、次の選択肢を使用して、エクスポートするテーブル API を選択します。
      フィールド
      名前空間
      API 名 テーブル API
      API バージョン 最新
    3. API メソッドのリストの下で、使用するエクスポート形式のリンクを選択します。
      オプション説明
      OpenAPI 仕様をエクスポート (YAML) YAML 形式でエクスポートします。
      OpenAPI 仕様をエクスポート (JSON) JSON 形式でエクスポートします。
      ブラウザーにダウンロード場所を選択するウィンドウが表示されます。
    4. ダウンロード場所とファイル名を選択します。
    5. ファイルを保存します。

    タスクの結果

    選択した形式で API がダウンロードされます。

    次のタスク

    Postman や Insomnia などの Web サービスツールに API をインポートします。