आम तौर पर, Mutate
, Search
, और SearchStream
तरीके इस्तेमाल किए जाते हैं
में, कुछ अन्य कामों के लिए भी इसका इस्तेमाल किया जा सकता है. सभी सेवाएं और
उनके एपीआई दस्तावेज़
REST से जुड़ा दस्तावेज़.
प्रोटोकॉल बफ़र RPC से REST मैपिंग
सभी सेवा एंडपॉइंट (REST और gRPC का इस्तेमाल किए जा रहे हों) आखिर में तय किए जाते हैं में सेवाओं पैकेज की.proto फ़ाइलें इसका इस्तेमाल करके proto3 इंटरफ़ेस डेफ़िनिशन लैंग्वेज.
उदाहरण: ListAccessibleCustomers
उदाहरण के लिए, customer_service.proto
फ़ाइल
स्टैंडर्ड Mutate
के अलावा, ListAccessibleCustomers
तरीके के बारे में बताता है
को अपनाएं. इसकी google.api.http
व्याख्या बताती है
एचटीटीपी पर कैसे मैप किया जाता है. इसमें कस्टम क्रिया के साथ एचटीटीपी GET
का इस्तेमाल किया गया है
listAccessibleCustomers
:
rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse) { option (google.api.http) = { get: "/v17/customers:listAccessibleCustomers" }; }
यह मैप customers.listAccessibleCustomers REST तरीका.
उदाहरण: CreateCustomerClient
customer_service.proto
का एक और उदाहरण यह है
CreateCustomerClient
तरीका. इसकी google.api.http
व्याख्या
कस्टम क्रिया createCustomerClient
का उपयोग करने वाली HTTP POST
:
rpc CreateCustomerClient(CreateCustomerClientRequest) returns (CreateCustomerClientResponse) { option (google.api.http) = { post: "/v17/customers/{customer_id=*}:createCustomerClient" body: "*" }; option (google.api.method_signature) = "customer_id,customer_client"; }
यह customers.createCustomerClient पर मैप होता है REST तरीका.