Apex REST のメソッド

Apex REST は、リソースを表現するために、JSON と XML の 2 つの形式をサポートしています。JSON による表現は、要求またはレスポンスボディにデフォルトで渡され、形式は、HTTP ヘッダーの Content-Type プロパティで示されます。本文は、Apex メソッドへのパラメータがない場合、HttpRequest オブジェクトから Blob として取得できます。パラメータが Apex メソッドに定義されている場合、リクエストボディをそれらのパラメータに並列化する試行が行われます。Apex メソッドの戻り値が non-void である場合、リソースの表現はレスポンスボディに逐次化されます。

次の戻り型とパラメータ型を使用できます。

• Apex プリミティブ (sObject と Blob を除く)
• sObjects
• Apex プリミティブまたは sObject のリストまたは対応付け (String キーの対応付けのみをサポート)
• 上記の型のメンバー変数を含むユーザ定義型

@HttpGet または @HttpDelete アノテーションのあるメソッドには、パラメータがありません。これは、GET 要求と DELETE 要求にはリクエストボディがなく、並列化するものがないためです。

1 つの Apex クラスにアノテーション @RestResource が付加されている場合、同一の HTTP 要求メソッドでアノテーションが付加されたメソッドを複数含めることはできません。たとえば、同じクラスにアノテーション @HttpGet が付加されたメソッドを 2 つ含めることはできません。

1@RestResource(urlMapping='/user_defined_type_example/*')
2global with sharing class MyOwnTypeRestResource {
3
4    @HttpPost
5    global static MyUserDefinedClass echoMyType(MyUserDefinedClass ic) {
6        return ic;
7    }
8
9    global class MyUserDefinedClass {
10
11        global String string1;
12        global String string2 { get; set; }
13        private String privateString;
14        global transient String transientString;
15        global static String staticString;
16
17    }
18    
19}

1{
2    "ic" : {
3                "string1" : "value for string1",
4                "string2" : "value for string2",
5                "privateString" : "value for privateString"
6            }
7}

1<request>
2    <ic>
3        <string1>value for string1</string1>
4        <string2>value for string2</string2>
5        <privateString>value for privateString</privateString>
6    </ic>
7</request>

1@RestResource(urlMapping='/CycleExample/*')
2global with sharing class ApexRESTCycleExample {
3 
4    @HttpGet
5    global static MyUserDef1 doCycleTest() {
6        MyUserDef1 def1 = new MyUserDef1();
7        MyUserDef2 def2 = new MyUserDef2();
8        def1.userDef2 = def2;
9        def2.userDef1 = def1;
10        return def1;
11    }
12 
13    global class MyUserDef1 {
14        MyUserDef2 userDef2;
15    }    
16 
17    global class MyUserDef2 {
18        MyUserDef1 userDef1;
19    }
20    
21}