この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Apex REST の概要

外部アプリケーションが REST アーキテクチャによってコードとアプリケーションにアクセスできるように、Apex クラスとメソッドを公開することができます。これは、REST リソースとして公開する Apex クラスを @RestResource アノテーションで定義して行います。同様に、他のアノテーションもメソッドに追加して、REST を通じて公開します。たとえば、@HttpGet アノテーションをメソッドに追加して、HTTP GET 要求から呼び出すことができる REST リソースとして公開できます。詳細は、Apex REST アノテーションを参照してください。

Apex REST で使用できるメソッドおよびプロパティを含むクラスを次に示します。

クラス 説明
RestContext クラス RestRequest オブジェクトと RestResponse オブジェクトを含みます。
request HTTP 要求から Apex RESTful Web サービスメソッドにデータを渡す場合に使用されるオブジェクトを表します。
response Apex RESTful Web サービスメソッドから HTTP 応答にデータを渡す場合に使用されるオブジェクトを表します。

ガバナ制限

Apex REST クラスへのコールは、組織の API ガバナ制限のカウントの対象です。すべての標準の Apex ガバナ制限は、Apex REST クラスに適用されます。たとえば、要求または応答の最大サイズは、同期 Apex の場合は 6 MB、非同期 Apex の場合は 12 MB です。詳細は、実行ガバナと制限を参照してください。

認証

Apex REST は、次の認証メカニズムをサポートしています。

  • OAuth2.0
  • セッション ID

『REST API 開発者ガイド』「ステップ 2: 認証を設定する」を参照してください。