https://github.com/0xtlt/shopify_api
A shopify api client for rust
https://github.com/0xtlt/shopify_api
rust shopify shopify-api
Last synced: about 1 year ago
JSON representation
A shopify api client for rust
- Host: GitHub
- URL: https://github.com/0xtlt/shopify_api
- Owner: 0xtlt
- License: mit
- Created: 2022-10-16T13:21:49.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-04T10:16:56.000Z (over 1 year ago)
- Last Synced: 2025-04-06T13:52:45.398Z (about 1 year ago)
- Topics: rust, shopify, shopify-api
- Language: Rust
- Homepage:
- Size: 666 KB
- Stars: 14
- Watchers: 3
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-shopify - Shopify API Client for Rust
README
# shopify_api
[](https://crates.io/crates/shopify_api)
[](https://docs.rs/shopify_api)
[](./LICENSE.txt)
[](https://github.com/0xtlt/shopify_api/actions/workflows/ci.yml)
[](https://img.shields.io/github/issues/0xtlt/shopify_api)
An ergonomic, Shopify API Client for Rust.
- GraphQL API support with automatic data deserialization
- [Changelog](CHANGELOG.md)
## Example
This asynchronous example uses [Tokio](https://tokio.rs) and enables some
optional features, so your `Cargo.toml` could look like this:
```toml
[dependencies]
shopify_api = "0.8"
tokio = { version = "1", features = ["full"] }
```
And then the code:
```rust,no_run
use shopify_api::*;
use shopify_api::utils::ReadJsonTreeSteps;
use serde::{Deserialize};
#[derive(Deserialize)]
struct Shop {
name: String,
}
#[tokio::main]
async fn main() -> Result<(), Box> {
let shopify = Shopify::new("hello", "world", String::from("2024-04"), None);
let graphql_query = r#"
query {
shop {
name
}
}"#;
let variables = serde_json::json!({});
let json_finder = vec![ReadJsonTreeSteps::Key("data"), ReadJsonTreeSteps::Key("shop")];
let shop: Shop = shopify.graphql_query(graphql_query, &variables, &json_finder).await.unwrap();
Ok(())
}
```
### Or with the `new` GraphQl Client!
```toml
[dependencies]
shopify_api = "0.89"
tokio = { version = "1", features = ["full"] }
graphql_client = "0.14.0"
```
```graphql
query GetShop {
shop {
name
}
}
```
```rust,no_run
use shopify_api::*;
use graphql_client::GraphQLQuery;
#[derive(GraphQLQuery)]
#[graphql(
schema_path = "./graphql.schema.json",
query_path = "graphql/getShop.graphql",
response_derives = "Debug"
)]
struct GetShop;
#[tokio::main]
async fn main() -> Result<(), Box> {
let shopify = Shopify::new("hello", "world", String::from("2024-04"), None);
let shop_info = connector
.shopify
.post_graphql::(get_shop::Variables {})
.await;
Ok(())
}
```
### Download the graphql schema
#### You can download one from this repository
- [2024-04](./schemas/2024-04.json)
#### Or download it from the Shopify Graphql API with [the following command](./schema_dl.graphql)
> [!WARNING]
> Sometimes you'll get an error with the GraphQLQuery derive caused my a missing struct, most of the time, you can fix it by adding the missing struct by importing it from [the types import](./src/graphql/types.rs) or you can create a new struct with the same name as the missing one, and the derive will work.
## License
Licensed under MIT license ([LICENSE-MIT](LICENSE-MIT) or )