|
17 | 17 | * Multi-part form/file uploads
|
18 | 18 | * T4 Helper to generate C# classes from an XML document
|
19 | 19 |
|
20 |
| -### Basic Usage |
21 |
| - var client = new RestClient("http://example.com"); |
22 |
| - // client.Authenticator = new HttpBasicAuthenticator(username, password); |
| 20 | +```csharp |
| 21 | +var client = new RestClient("http://example.com"); |
| 22 | +// client.Authenticator = new HttpBasicAuthenticator(username, password); |
23 | 23 |
|
24 |
| - var request = new RestRequest("resource/{id}", Method.POST); |
25 |
| - request.AddParameter("name", "value"); // adds to POST or URL querystring based on Method |
26 |
| - request.AddUrlSegment("id", 123); // replaces matching token in request.Resource |
| 24 | +var request = new RestRequest("resource/{id}", Method.POST); |
| 25 | +request.AddParameter("name", "value"); // adds to POST or URL querystring based on Method |
| 26 | +request.AddUrlSegment("id", 123); // replaces matching token in request.Resource |
27 | 27 |
|
28 |
| - // add parameters for all properties on an object |
29 |
| - request.AddObject(object); |
| 28 | +// add parameters for all properties on an object |
| 29 | +request.AddObject(object); |
30 | 30 |
|
31 |
| - // or just whitelisted properties |
32 |
| - request.AddObject(object, "PersonId", "Name", ...); |
| 31 | +// or just whitelisted properties |
| 32 | +request.AddObject(object, "PersonId", "Name", ...); |
33 | 33 |
|
34 |
| - // easily add HTTP Headers |
35 |
| - request.AddHeader("header", "value"); |
| 34 | +// easily add HTTP Headers |
| 35 | +request.AddHeader("header", "value"); |
36 | 36 |
|
37 |
| - // add files to upload (works with compatible verbs) |
38 |
| - request.AddFile(path); |
| 37 | +// add files to upload (works with compatible verbs) |
| 38 | +request.AddFile(path); |
39 | 39 |
|
40 |
| - // execute the request |
41 |
| - RestResponse response = client.Execute(request); |
42 |
| - var content = response.Content; // raw content as string |
| 40 | +// execute the request |
| 41 | +RestResponse response = client.Execute(request); |
| 42 | +var content = response.Content; // raw content as string |
43 | 43 |
|
44 |
| - // or automatically deserialize result |
45 |
| - // return content type is sniffed but can be explicitly set via RestClient.AddHandler(); |
46 |
| - RestResponse<Person> response2 = client.Execute<Person>(request); |
47 |
| - var name = response2.Data.Name; |
| 44 | +// or automatically deserialize result |
| 45 | +// return content type is sniffed but can be explicitly set via RestClient.AddHandler(); |
| 46 | +RestResponse<Person> response2 = client.Execute<Person>(request); |
| 47 | +var name = response2.Data.Name; |
48 | 48 |
|
49 |
| - // or download and save file to disk |
50 |
| - client.DownloadData(request).SaveAs(path); |
| 49 | +// or download and save file to disk |
| 50 | +client.DownloadData(request).SaveAs(path); |
51 | 51 |
|
52 |
| - // easy async support |
53 |
| - client.ExecuteAsync(request, response => { |
54 |
| - Console.WriteLine(response.Content); |
55 |
| - }); |
| 52 | +// easy async support |
| 53 | +client.ExecuteAsync(request, response => { |
| 54 | + Console.WriteLine(response.Content); |
| 55 | +}); |
56 | 56 |
|
57 |
| - // async with deserialization |
58 |
| - var asyncHandle = client.ExecuteAsync<Person>(request, response => { |
59 |
| - Console.WriteLine(response.Data.Name); |
60 |
| - }); |
61 |
| - |
62 |
| - // abort the request on demand |
63 |
| - asyncHandle.Abort(); |
| 57 | +// async with deserialization |
| 58 | +var asyncHandle = client.ExecuteAsync<Person>(request, response => { |
| 59 | + Console.WriteLine(response.Data.Name); |
| 60 | +}); |
| 61 | + |
| 62 | +// abort the request on demand |
| 63 | +asyncHandle.Abort(); |
| 64 | +``` |
64 | 65 |
|
65 | 66 | [1]: http://restsharp.org
|
66 | 67 | [2]: http://twitter.com/RestSharp
|
|
0 commit comments