Update examples to use JsonApiClient

mythz · mythz · commit 6b1b9fd822e9 · 2025-05-14T18:57:53.000+08:00
diff --git a/MyApp/_includes/jwt-service-clients.md b/MyApp/_includes/jwt-service-clients.md
@@ -11,7 +11,7 @@ automatically supports fetching new JWT Bearer Tokens & transparently Auto Retry
 #### C#, F# & VB .NET Service Clients
 
 ```csharp
-var client = new JsonServiceClient(baseUrl);
+var client = new JsonApiClient(baseUrl);
 var authRequest = new Authenticate {
     provider = "credentials",
     UserName = userName,
diff --git a/MyApp/_pages/advantages-of-message-based-web-services.md b/MyApp/_pages/advantages-of-message-based-web-services.md
@@ -230,14 +230,14 @@ But even without this, ServiceStack services are just as consumable as any other
 The earlier typed API example of creating a new TODO in C#:
 
 ```csharp
-var client = new JsonServiceClient(baseUrl);
+var client = new JsonApiClient(baseUrl);
 Todo createdTodo = client.Post(new Todo { Content = "New Todo", Order = 1 });
 ```
 
 Is like this in [TypeScript](/typescript-add-servicestack-reference):
 
 ```ts
-var client = new JsonServiceClient(baseUrl);
+var client = new JsonApiClient(baseUrl);
 var request = Todo();
 request.Content = "New Todo";
 request.Order = 1;
diff --git a/MyApp/_pages/api-design.md b/MyApp/_pages/api-design.md
@@ -338,7 +338,7 @@ public class Contact { ... }
 Which can used in any ServiceClient with:
 
 ```csharp
-var client = new JsonServiceClient(BaseUri);
+var client = new JsonApiClient(BaseUri);
 List<Contact> response = client.Get(new GetContacts());
 ```
 
@@ -351,7 +351,7 @@ can alternatively choose to use [Add ServiceStack Reference](/csharp-add-service
 alternative way to get the Services typed DTOs on the client. In both cases the exact same source code is used to call the Services:
 
 ```csharp
-var client = new JsonServiceClient(BaseUri);
+var client = new JsonApiClient(BaseUri);
 var response = client.Get(new GetContacts());
 ```
 
diff --git a/MyApp/_pages/auth/api-key-authprovider.md b/MyApp/_pages/auth/api-key-authprovider.md
@@ -87,7 +87,7 @@ curl https://api.stripe.com/v1/charges -H "Authorization: Bearer yDOr26HsxyhpuRB
 Both of these methods are built into most HTTP Clients. Here are a few different ways which you can send them using ServiceStack's [.NET Service Clients](/csharp-client):
 
 ```csharp
-var client = new JsonServiceClient(baseUrl) {
+var client = new JsonApiClient(baseUrl) {
     Credentials = new NetworkCredential(apiKey, "")
 };
 
diff --git a/MyApp/_pages/auth/auth-repository.md b/MyApp/_pages/auth/auth-repository.md
@@ -391,7 +391,7 @@ More examples of this are in [ManageRolesTests.cs](https://github.com/ServiceSta
 Super Users with the **Admin** role or Requests with an [AdminAuthSecret](/debugging#authsecret) can call the built-in `/assignroles` and `/unassignroles` Services to add Roles/Permissions to existing users from an external Request, e.g:
 
 ```csharp
-var client = new JsonServiceClient(baseUrl);
+var client = new JsonApiClient(baseUrl);
 var response = client.Post(new AssignRoles
 {
     UserName = userName,
diff --git a/MyApp/_pages/auth/authentication-and-authorization.md b/MyApp/_pages/auth/authentication-and-authorization.md
@@ -501,7 +501,7 @@ On the client you can use the [C#/.NET Service Clients](/csharp-client) to easil
 To authenticate using your `CustomCredentialsAuthProvider` by POST'ing a `Authenticate` Request, e.g:
 
 ```csharp
-var client = new JsonServiceClient(BaseUrl);
+var client = new JsonApiClient(BaseUrl);
 
 var authResponse = client.Post(new Authenticate {
     provider = CredentialsAuthProvider.Name, //= credentials
diff --git a/MyApp/_pages/auth/encrypted-messaging.md b/MyApp/_pages/auth/encrypted-messaging.md
@@ -48,7 +48,7 @@ It's safer instead to download the public key over a trusted `https://` url wher
 Since `GetPublicKey` is just a ServiceStack Service it's easily downloadable using a Service Client:
 
 ```csharp
-var client = new JsonServiceClient(BaseUrl);
+var client = new JsonApiClient(BaseUrl);
 string publicKeyXml = client.Get(new GetPublicKey());
 ```
 
@@ -68,7 +68,7 @@ To help with verification the SHA256 Hash of the PublicKey is returned in `X-Pub
 Once they have the Server's Public Key, clients can use it to get an `EncryptedServiceClient` via the `GetEncryptedClient()` extension method on `JsonServiceClient` or new `JsonHttpClient`, e.g:
 
 ```csharp
-var client = new JsonServiceClient(BaseUrl);
+var client = new JsonApiClient(BaseUrl);
 IEncryptedClient encryptedClient = client.GetEncryptedClient(publicKeyXml);
 ```
 
diff --git a/MyApp/_pages/auth/identityserver.md b/MyApp/_pages/auth/identityserver.md
@@ -251,7 +251,7 @@ public async Task<IActionResult> CallServiceClient()
 {
     var accessToken = await HttpContext.GetTokenAsync("access_token");
 
-    var client = new JsonServiceClient("https://localhost:5001/") {
+    var client = new JsonApiClient("https://localhost:5001/") {
         BearerToken = accessToken
     };
     var response = await client.GetAsync(new GetIdentity());
diff --git a/MyApp/_pages/auth/jwt-authprovider.md b/MyApp/_pages/auth/jwt-authprovider.md
@@ -117,7 +117,7 @@ The JWT Auth Provider defaults to `RequireSecureConnection=true` which mandates
 JWT Tokens can be sent using the Bearer Token support in all HTTP and Service Clients:
 
 ```csharp
-var client = new JsonServiceClient(baseUrl) {
+var client = new JsonApiClient(baseUrl) {
     BearerToken = jwtToken
 };
 
diff --git a/MyApp/_pages/auto-batched-requests.md b/MyApp/_pages/auto-batched-requests.md
@@ -14,7 +14,7 @@ Thanks to it's [message-based design](/advantages-of-message-based-web-services)
 This is enabled in all [.NET Service Clients](/csharp-client) via the new `SendAll()` and `SendAllOneWay()` API's, e.g:
 
 ```csharp
-var client = new JsonServiceClient(BaseUrl);
+var client = new JsonApiClient(BaseUrl);
 var requests = new[]
 {
     new Request { Id = 1, Name = "Foo" },
diff --git a/MyApp/_pages/autoquery/crud.md b/MyApp/_pages/autoquery/crud.md
@@ -91,7 +91,7 @@ public class CreateRockstarResponse
 When ServiceStack starts it generates the implementation for this Service, which can now insert Rockstars using your populated Request DTO:
 
 ```csharp
-var client = new JsonServiceClient(baseUrl);
+var client = new JsonApiClient(baseUrl);
 
 client.Post(new CreateRockstar {
     FirstName = "Kurt",
diff --git a/MyApp/_pages/autoquery/rdbms.md b/MyApp/_pages/autoquery/rdbms.md
@@ -1445,7 +1445,7 @@ public class CustomAutoQueryServices(IAutoQueryDb autoQuery) : Service
 As AutoQuery Services are normal ServiceStack Services they can re-use the existing Service Client support for [Auto Batched Requests](/auto-batched-requests), e.g:
 
 ```csharp
-var client = new JsonServiceClient(BaseUrl);
+var client = new JsonApiClient(BaseUrl);
 var response = client.SendAll(new CreateItem[] { ... });
 ```
 
diff --git a/MyApp/_pages/csharp-client.md b/MyApp/_pages/csharp-client.md
@@ -50,13 +50,13 @@ builder.Services.AddBlazorApiClient(builder.Configuration["ApiBaseUrl"] ?? build
 All ServiceStack's C# clients share the same interfaces and are created by passing in the **Base URI** of your ServiceStack service in the clients constructor, e.g. if your ServiceStack instance was hosted on the root path `/` on the **5001** custom port:
 
 ```csharp
-var client = new JsonServiceClient("https://host:5001");
+var client = new JsonApiClient("https://host:5001");
 ```
 
 Or if hosted on the `/custom` custom path:
 
 ```csharp
-var client = new JsonServiceClient("https://host/custom/");
+var client = new JsonApiClient("https://host/custom/");
 ```
 
 ### Recommended ServiceClient for .NET 6+#
diff --git a/MyApp/_pages/error-handling.md b/MyApp/_pages/error-handling.md
@@ -37,7 +37,7 @@ All Exceptions get injected into the `ResponseStatus` property of your Response
 ```csharp 
 try 
 {
-    var client = new JsonServiceClient(BaseUri);
+    var client = new JsonApiClient(BaseUri);
     var response = client.Send<UserResponse>(new User());
 } 
 catch (WebServiceException webEx) 
diff --git a/MyApp/_pages/fsharp-add-servicestack-reference.md b/MyApp/_pages/fsharp-add-servicestack-reference.md
@@ -35,7 +35,7 @@ As there's no configuration stored about the ServiceStack Reference you might be
 Just like with C#, F# Native Types can be used in ServiceStack's [Generic Service Clients](/csharp-client) providing and end-to-end Typed API whose PCL support also allows F# to be used in [mobile clients apps](https://github.com/ServiceStackApps/HelloMobile) without having to share compiled DTOs:
 
 ```fsharp
-let client = new JsonServiceClient("https://blazor-vue.web-templates.io")
+let client = new JsonApiClient("https://blazor-vue.web-templates.io")
 let response = client.Get(new SearchQuestions(
     Tags = new List<string>([ "redis"; "ormlite" ])))        
 
diff --git a/MyApp/_pages/grpc/index.md b/MyApp/_pages/grpc/index.md
@@ -122,7 +122,7 @@ code-gen, etc is required to maintain its simple code-first development model ut
 end-to-end Typed API utilizing smart, rich .NET generic Service Clients:
 
 ```csharp
-//IRestServiceClient client = new JsonServiceClient(BaseUrl);
+//IRestServiceClient client = new JsonApiClient(BaseUrl);
 IRestServiceClient client = new GrpcServiceClient(BaseUrl);
 var response = await client.GetAsync(new GetTodos());
 ```
diff --git a/MyApp/_pages/howto-write-unit-integration-tests.md b/MyApp/_pages/howto-write-unit-integration-tests.md
@@ -126,7 +126,7 @@ public class CustomerRestExample
     [Test]
     public void Run_Customer_REST_Example()
     {
-        var client = new JsonServiceClient(BaseUri);
+        var client = new JsonApiClient(BaseUri);
 
         //GET /customers
         var all = client.Get(new GetCustomers());
diff --git a/MyApp/_pages/messaging.md b/MyApp/_pages/messaging.md
@@ -270,7 +270,7 @@ mqServer.DisablePriorityQueues = true;
 Using the `SendOneWay()` Service Client APIs will publish DTO's to the `/oneway` [Pre-defined Route](/routing#pre-defined-routes):
 
 ```csharp
-var client = new JsonServiceClient(BaseUrl);
+var client = new JsonApiClient(BaseUrl);
 client.SendOneWay(new RequestDto { ... }); //POST's to /json/oneway/RequestDto
 ```
 
@@ -481,7 +481,7 @@ new AppHost().Start("http://localhost:1337/");
 Then on the Client we can authenticate using UserName/Password credentials using the HTTP [Service Client](/csharp-client), e.g:
 
 ```csharp
-var client = new JsonServiceClient("http://localhost:1337/");
+var client = new JsonApiClient("http://localhost:1337/");
 
 var response = client.Post(new Authenticate {
     UserName = "mythz",
diff --git a/MyApp/_pages/multitenancy.md b/MyApp/_pages/multitenancy.md
@@ -374,7 +374,7 @@ public class MultiTenantService : Service
 Calling this Service with a different `TenantId` value changes which database the Service is configured with:
 
 ```csharp
-var client = new JsonServiceClient(Config.AbsoluteBaseUri);
+var client = new JsonApiClient(Config.AbsoluteBaseUri);
 
 var response = client.Get(new GetTenant()); //= Company: Masters inc. 
 
diff --git a/MyApp/_pages/netcore-localhost-cert.md b/MyApp/_pages/netcore-localhost-cert.md
@@ -227,7 +227,7 @@ Now after restarting your browser to reset its SSL caches you'll be able to use
 As .NET has access your OS's trusted certificates you'll be able to access the custom domains without additional configuration:
 
 ```csharp
-var client = new JsonServiceClient("https://dev.servicestack.com:5001"); //.NET HttpWebRequest
+var client = new JsonApiClient("https://dev.servicestack.com:5001"); //.NET HttpWebRequest
 var response = await client.GetAsync(new Hello { Name = "World" });
 
 var client = new JsonHttpClient("https://dev.servicestack.com:5001");    //.NET HttpClient
diff --git a/MyApp/_pages/post-command.md b/MyApp/_pages/post-command.md
@@ -280,7 +280,7 @@ dotnet add package ServiceStack.Client
 Which together with the above C# DTOs enables its optimal end-to-end typed API:
 
 ```csharp
-var client = new JsonServiceClient("https://techstacks.io");
+var client = new JsonApiClient("https://techstacks.io");
 
 client.Send(new LockTechStack { TechnologyStackId = id, IsLocked = true });
 ```
diff --git a/MyApp/_pages/proxy-feature.md b/MyApp/_pages/proxy-feature.md
@@ -43,7 +43,7 @@ x csharp https://external.domain.com/techstacks
 The resulting DTOs can be used with any [.NET Service Client](/csharp-client#built-in-clients), configured with the proxy endpoint as the **BaseUrl**:
  
 ```csharp
-var client = new JsonServiceClient("https://external.domain.com/techstacks");
+var client = new JsonApiClient("https://external.domain.com/techstacks");
  
 var request = new GetTechnology { Slug = "ServiceStack" };
 var response = client.Get(request);
@@ -55,7 +55,7 @@ Another potential use-case is to have the proxy act like a facade to access mult
 ```csharp
 var authRequest = new Authenticate { ... };
  
-var marketingClient = new JsonServiceClient("https://external.domain.com/marketing");
+var marketingClient = new JsonApiClient("https://external.domain.com/marketing");
 var authResponse = marketingClient.Post(authRequest);
  
 var financeClient = new JsonHttpClient("https://external.domain.com/finance");
diff --git a/MyApp/_pages/soap-support.md b/MyApp/_pages/soap-support.md
@@ -69,7 +69,7 @@ var response = client.Send(new GetCustomers());
 Although if you could use a generic ServiceClient, you'd typically be better off using the other cleaner and faster endpoints like JSON instead:
 
 ```csharp
-var client = new JsonServiceClient(BaseUrl);
+var client = new JsonApiClient(BaseUrl);
 
 var response = client.Get(new GetCustomers());
 ```
diff --git a/MyApp/_pages/testing.md b/MyApp/_pages/testing.md
@@ -108,7 +108,7 @@ public class CustomerRestExample
     [Test]
     public void Can_GET_and_Create_Customers()
     {
-        var client = new JsonServiceClient(BaseUri);
+        var client = new JsonApiClient(BaseUri);
 
         //GET /customers
         var all = client.Get(new GetCustomers());
diff --git a/MyApp/_pages/validation.md b/MyApp/_pages/validation.md
@@ -68,7 +68,7 @@ All Exceptions gets injected into the ResponseStatus property of your Response D
 ```csharp 
 try 
 {
-    var client = new JsonServiceClient(BaseUri);
+    var client = new JsonApiClient(BaseUri);
     var response = client.Send<UserResponse>(new User());
 } 
 catch (WebServiceException webEx) 
diff --git a/MyApp/_pages/vbnet-add-servicestack-reference.md b/MyApp/_pages/vbnet-add-servicestack-reference.md
@@ -33,7 +33,7 @@ If your server has been updated and you want to update to client DTOs, simply ri
 Async Example:
 
 ```vb
-Dim client = New JsonServiceClient("https://techstacks.io")
+Dim client = new JsonApiClient("https://techstacks.io")
 
 Dim response = Await client.SendAsync(New AppOverview())
 response.PrintDump()
@@ -42,7 +42,7 @@ response.PrintDump()
 Sync Example:
 
 ```vb
-Dim client = New JsonServiceClient("https://techstacks.io")
+Dim client = new JsonApiClient("https://techstacks.io")
 
 Dim response = client.Send(New AppOverview())
 response.PrintDump()
diff --git a/MyApp/_pages/why-servicestack.md b/MyApp/_pages/why-servicestack.md
@@ -253,7 +253,7 @@ public class CustomerService : Service
 No code-gen required, can re-use above Server DTOs:
 
 ```csharp
-var client = new JsonServiceClient(BaseUri);
+var client = new JsonApiClient(BaseUri);
 
 //GET /customers
 var all = client.Get(new GetCustomers());                         // Count = 0
diff --git a/MyApp/_pages/your-first-webservice-explained.md b/MyApp/_pages/your-first-webservice-explained.md
@@ -53,7 +53,7 @@ public class HelloService : Service
 Thanks to the above `IReturn<T>` interface marker you'll be able to use the terse, typed Service Client APIs, e.g:
 
 ```csharp
-var client = new JsonServiceClient(BaseUri);
+var client = new JsonApiClient(BaseUri);
 
 HelloResponse response = client.Get(new Hello { Name = "World" }); 
 ```

Original file line number	Diff line number	Diff line change
`@@ -391,7 +391,7 @@ More examples of this are in [ManageRolesTests.cs](https://github.com/ServiceSta`
`391`	`391`	Super Users with the Admin role or Requests with an [AdminAuthSecret](/debugging#authsecret) can call the built-in `/assignroles` and `/unassignroles` Services to add Roles/Permissions to existing users from an external Request, e.g:
`392`	`392`
`393`	`393`	```csharp
`394`		`-var client = new JsonServiceClient(baseUrl);`
	`394`	`+var client = new JsonApiClient(baseUrl);`
`395`	`395`	`var response = client.Post(new AssignRoles`
`396`	`396`	`{`
`397`	`397`	`UserName = userName,`
Original file line number	Diff line number	Diff line change
`@@ -251,7 +251,7 @@ public async Task<IActionResult> CallServiceClient()`
`251`	`251`	`{`
`252`	`252`	`var accessToken = await HttpContext.GetTokenAsync("access_token");`
`253`	`253`
`254`		`- var client = new JsonServiceClient("https://localhost:5001/") {`
	`254`	`+ var client = new JsonApiClient("https://localhost:5001/") {`
`255`	`255`	`BearerToken = accessToken`
`256`	`256`	`};`
`257`	`257`	`var response = await client.GetAsync(new GetIdentity());`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ Thanks to it's [message-based design](/advantages-of-message-based-web-services)`
`14`	`14`	This is enabled in all [.NET Service Clients](/csharp-client) via the new `SendAll()` and `SendAllOneWay()` API's, e.g:
`15`	`15`
`16`	`16`	```csharp
`17`		`-var client = new JsonServiceClient(BaseUrl);`
	`17`	`+var client = new JsonApiClient(BaseUrl);`
`18`	`18`	`var requests = new[]`
`19`	`19`	`{`
`20`	`20`	`new Request { Id = 1, Name = "Foo" },`