Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rdavydenko/smartgraphqlclient
Back-to-back GraphQL client using Linq-syntax
https://github.com/rdavydenko/smartgraphqlclient
back-to-back csharp graphql graphql-client linq linq-to-graphql open-source
Last synced: 3 days ago
JSON representation
Back-to-back GraphQL client using Linq-syntax
- Host: GitHub
- URL: https://github.com/rdavydenko/smartgraphqlclient
- Owner: RDavydenko
- Created: 2023-06-23T13:25:01.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-02T21:51:27.000Z (about 2 months ago)
- Last Synced: 2024-09-23T19:02:13.487Z (4 days ago)
- Topics: back-to-back, csharp, graphql, graphql-client, linq, linq-to-graphql, open-source
- Language: C#
- Homepage:
- Size: 121 KB
- Stars: 11
- Watchers: 1
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SmartGraphQLClient
Back-to-back GraphQL client using Linq-syntax
## Install NuGet package
Using Package Manager:
``` shell
Install-Package SmartGraphQLClient
```
or
Using .NET CLI:
``` shell
dotnet add package SmartGraphQLClient
```
## Usage
### 1. Add required services to DI
``` csharp
using SmartGraphQLClient;
services.AddSmartGraphQLClient();
```
### 2. Write GraphQL-request with Linq-syntax
``` csharp
using SmartGraphQLClient;
GraphQLHttpClient client = ... // from DI
var users = await client.Query("users")
.Include(x => x.Roles)
.ThenInclude(x => x.Users)
.Where(x => x.UserName.StartsWith("A") || x.Roles.Any(r => r.Code == RoleCode.ADMINISTRATOR))
.OrderBy(x => x.Id)
.ThenByDescending(x => x.UserName)
.Select(x => new
{
x.Id,
Name = x.UserName,
x.Roles,
IsAdministrator = x.Roles.Any(r => r.Code == RoleCode.ADMINISTRATOR)
})
.Skip(5)
.Take(10)
.Argument("secretKey", "1234")
.ToListAsync();
```
## Explanation
When you call materializing method (`ToListAsync()`, `ToArrayAsync()`, `FirstAsync()`, etc.), the `GraphQLHttpClient` will build a string query and send it to the GraphQL-server, get a response and materialize the result.
Query-string from example:
``` graphql
{
users (
where: {
or: [
{ userName: { startsWith: "A" } }
{ roles: { some: { code: { eq: ADMINISTRATOR } } } }
]
}
order: [
{ id: ASC }
{ userName: DESC }
]
skip: 5
take: 10
secretKey: "1234"
) {
id
userName
roles {
code
name
description
id
users {
userName
age
id
}
}
}
}
```
## More examples
See more examples in unit-tests [directory](https://github.com/RDavydenko/SmartGraphQLClient/tree/master/src/SmartGraphQLClient.Tests/Core/GraphQLHttpClient):
1) more requests (`ToListAsync()`, `ToPageAsync()`, `FirstOrDefaultAsync()`)
2) attributes (`GraphQLEndpointAttribute`, `GraphQLIgnoreAttribute`, `GraphQLPropertyNameAttribute`)
3) authorized graphql-http-client (`IGraphQLAuthorizationService<>` for providing tokens in runtime and cache tokens)
4) and more
## Compatibility
Requests were tested on [HotChocolate](https://github.com/ChilliCream/graphql-platform/) GraphQL-server. See their [documentation](https://chillicream.com/docs/hotchocolate/v13).
## Features
| feature's name | package's version | |
|----------------------------|----------------|----|
| Build Where-string | 1.0.0 | ✅ |
| Build Select-string | 1.0.0 | ✅ |
| Build Order-string | 1.0.0 | ✅ |
| Offset paging (skip, take) | 1.0.0 | ✅ |
| Custom arguments | 1.0.0 | ✅ |
| Execute raw query | 1.1.0 | ✅ |
| Cursor paging | | ❌ |
## Links
https://www.nuget.org/packages/SmartGraphQLClient/