Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ilyamatsuev/apex-graphql-client
The package for Salesforce that provides a convenient way to communicate with a GraphQL server via Apex.
https://github.com/ilyamatsuev/apex-graphql-client
apex graphql graphql-client library salesforce
Last synced: 3 months ago
JSON representation
The package for Salesforce that provides a convenient way to communicate with a GraphQL server via Apex.
- Host: GitHub
- URL: https://github.com/ilyamatsuev/apex-graphql-client
- Owner: IlyaMatsuev
- License: mit
- Created: 2021-07-02T04:40:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-11T22:28:19.000Z (10 months ago)
- Last Synced: 2024-10-11T13:03:38.110Z (3 months ago)
- Topics: apex, graphql, graphql-client, library, salesforce
- Language: Apex
- Homepage:
- Size: 472 KB
- Stars: 37
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Saleforce Apex GraphQL Client
[](https://github.com/IlyaMatsuev/Apex-GraphQL-Client/actions/workflows/scratch-test.yml)
[](https://codecov.io/gh/IlyaMatsuev/Apex-GraphQL-Client)
The package for Salesforce that aimed to provide a convenient way to communicate with a GraphQL server via Apex.
What is supported:
- ✅ Building queries, mutations and subscriptions
- ✅ Building graphql nodes (fields). If you want to send requests yourself
- ✅ Passing arguments to the graphql nodes (fields)
- ✅ Passing variables to the graphql operations from request
- ✅ Passing directives to the graphql operations and nodes
- ✅ Using fragments for graphql requests. Inline fragments are supported as well.
- ✅ Sync and async graphql HTTP client for sending requests (with callback implementation for async calls)
- ✅ Handling responses in GraphQL format
What is NOT supported:
- ❌ Sending subscription requests (WebSocket protocol is not supported by Apex)
If you think there is something that is not implemented yet as for GraphQL client I'd appreciate if you open an issue/discussion in this repository.
## 🔍 Overview
### Generate a GraphQL node
GraphQL node statement:
```bash
continents {
name
countries {
name
capital
currency
}
}
```
Equivalent Apex code:
```java
GraphQLField continents = new GraphQLField('continents')
.withField('name')
.withField(new GraphQLField(
'countries',
new List { 'name', 'capital', 'currency' }
));
// Will print a well-formatted node just like on the example above
System.debug(continents.build(true));
```
### Create a query GraphQL request
GraphQL query statement:
```bash
query {
countries(filter: "Bel", count: 1) {
name
capital
currency
}
continents {
name
}
}
```
Equivalent Apex code:
```java
GraphQLField countries = new GraphQLField(
'countries',
new List { 'name', 'capital', 'currency' }
)
.withArgument('filter', 'Bel')
.withArgument('count', 1);
GraphQLField continents = new GraphQLField(
'continents',
new List { 'name' }
);
GraphQLQuery query = new GraphQLQuery(
new List { countries, continents }
);
System.debug(query.build(true));
```
After you created a query or mutation you can send it to the GraphQL endpoint:
```java
...
GraphQLRequest request = query.asRequest();
// Add custom header if needed
request.withHeader('Authorization', 'Bearer token');
// Provide a GraphQL endpoint to the client
GraphQLHttpClient client = new GraphQLHttpClient('https://gql-endpoint.com/graphql');
GraphQLResponse response = client.send(request);
// Check if there are any errors and data
System.debug(response.hasErrors());
System.debug(response.hasData());
List errors = response.getErrors();
Map dataAsMap = response.getData();
// It's also possible to get data as any Apex class type
SomeWrapper dataAsWrapper = (SomeWrapper) response.getDataAs(SomeWrapper.class);
```
Alternatively, sometimes it's easier to just send a request as a plain string, so you can do:
```java
String query = 'query { countries { name, capital, currency } }';
GraphQLRequest request = new GraphQLRequest(query);
// Provide a GraphQL endpoint to the client
GraphQLHttpClient client = new GraphQLHttpClient('https://gql-endpoint.com/graphql');
GraphQLResponse response = client.send(request);
...
```
All examples can be found [here](docs/examples/).
## 🚀 Installation
### From Unmanaged Package
You can just install the package by the link on a [sandbox](http://test.salesforce.com/packaging/installPackage.apexp?p0=04t7R000000FE1lQAG) or [dev org](http://login.salesforce.com/packaging/installPackage.apexp?p0=04t7R000000FE1lQAG).
If you prefer using salesforce CLI you can simply run:
```bash
sfdx package:install -p 04t7R000000FE1lQAG -w 10 -b 10 -o
```
### From Source
You can also install the package with the automated scripts: [`pkg-deploy.sh`](scripts/pkg-deploy.sh) and [`pkg-from-scratch.sh`](scripts/pkg-from-scratch.sh). First is for deploying changes to the existing org:
```bash
./scripts/pkg-deploy.sh
```
Second is for creating a new configured scratch org:
```bash
./scripts/pkg-from-scratch.sh
```
## 📝 Documentation
For more detailed information about the content of the repository and the package, please visit [the documentation page](https://ilyamatsuev.github.io/Apex-GraphQL-Client/).
There is also a nice article on [medium.com](https://medium.com/@justin.wills_27437/intro-to-graphql-in-apex-salesforce-ccedb514d3c5) by [Justin Wills](https://medium.com/@justin.wills_27437) about how to use this library with the Shopify integration. He has also posted [a video on YouTube](https://www.youtube.com/watch?v=KfooQmDCGnk&t=6s) for the same topic.
The changelog is [here](https://ilyamatsuev.github.io/Apex-GraphQL-Client/#/changelog).
## ❓ Questions
If you have any questions you can start a discussion. If you think something works not as expected you can create an issue. If you want to request a new feature you can create an issue with the appropriate template selected.
## 🤝 Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](LICENSE)