Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spring-media/graphqlicious
A swift component with a DSL to declare GraphQL queries and to get string representations out of them
https://github.com/spring-media/graphqlicious
apps dsl graphql graphql-query swift
Last synced: 12 days ago
JSON representation
A swift component with a DSL to declare GraphQL queries and to get string representations out of them
- Host: GitHub
- URL: https://github.com/spring-media/graphqlicious
- Owner: spring-media
- License: mit
- Archived: true
- Created: 2016-03-30T14:52:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-09-18T09:15:07.000Z (about 1 year ago)
- Last Synced: 2024-10-29T09:14:35.542Z (15 days ago)
- Topics: apps, dsl, graphql, graphql-query, swift
- Language: Swift
- Size: 336 KB
- Stars: 76
- Watchers: 20
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GraphQLicious
GraphQLicious is a swift component that provides an intuitive and convenient way to build GraphQL queries and convert them easily to String representations.
[![iOS 8] (https://img.shields.io/badge/iOS%208%2B%20%7C%20MacOS%20X%2B%20%7C%20TV%20OS%20%7C%20Watch%20OS%202%2B-Compatible-brightgreen.svg)] ()
[](https://github.com/Carthage/Carthage)
[](http://cocoapods.org/pods/GraphQLicious)
[](https://developer.apple.com/swift)
[](http://cocoapods.org/pods/GraphQLicious)
[](https://travis-ci.org/WeltN24/GraphQLicious)
[](https://codebeat.co/projects/github-com-weltn24-graphqlicious)
[](https://codecov.io/gh/WeltN24/GraphQLicious)
# Contents
- [Installation](#installation)
- [Usage](#usage)
- [Breaking changes](#breaking-changes)
- [Authors](#authors)
- [License](#license)
## Installation
### Carthage
`GraphQLicious` supports Carthage. To install it, simply add the following line to your Cartfile
```
github "WeltN24/GraphQLicious"
```
### CocoaPods
`GraphQLicious` is available through CocoaPods. To install it, simply add the following line to your Podfile
```
pod "GraphQLicious"
```
### Submodule
If you don't use CocoaPods, you can still add `GraphQLicious` as a submodule, drag and drop `GraphQLicious.xcodeproj` into your project, and embed `GraphQLicious.framework` in your target.
- Drag `GraphQLicious.xcodeproj` to your project
- Select your app target
- Click the + button on the Embedded binaries section
- Add `GraphQLicious.framework`
### Manual
You can directly drag and drop the needed files into your project, but keep in mind that this way you won't be able to automatically get all the latest features.
The files are contained in the `Sources` folder and work for the `iOS` framework
## Usage
### Query
Let's assume, we have the id of an article and we want to have the `headline`, `body` text and `opener image` of that article.
Our graphQL query for that will look like this:
```graphQL
query {
test: content(id: 153082687){
...contentFields
}
}
fragment contentFields on Content {
headline,
body,
image(role: "opener", enum: [this, that]){
...imageContent
}
}
fragment imageContent on Image {
id
url
}
fragment urlFragment on Image {
url (ratio: 1, size: 200)
}
```
First, let's create a `Fragment` to fetch the contents of an image, namely the image `id` and the image `url`
```swift
let imageContent = Fragment(
withAlias: "imageContent",
name: "Image",
fields: [
"id",
"url"
]
)
```
Next, let's embed the `Fragment` into a `Request` that gets the opener image.
**Note:** `Argument` values that are of type `String` are automatically represented with quotes.
**GraphQL** also gives us the possibility to have custom enums as argument values. All you have to do is letting your enum implement `ArgumentValue` and you're good to go.
```swift
enum customEnum: String, ArgumentValue {
case This = "this"
case That = "that"
private var asGraphQLArgument: String {
return rawValue // without quotes
}
}
let customEnumArgument = Argument(
key: "enum",
values: [
customEnum.This,
customEnum.That
]
)
```
```swift
let imageContentRequest = Request(
name: "image",
arguments: [
Argument(key: "role", value: "opener"),
customEnumArgument
],
fields: [
imageContent
]
)
```
So now we have a Request with an embedded Fragment. Let's go one step further.
If we want to, we can imbed that Request into another Fragment. (We can also embed Fragments into Fragments)
Additionally to the opener image with its id and url we also want the `headline` and `body` text of the article.
```swift
let articleContent = Fragment(
withAlias: "contentFields",
name: "Content",
fields: [
"headline",
"body",
imageContentRequest
]
)
```
Finally, we put everything together as a `Query`. A Query always has a top level Request to get everything started, and requires all the Fragments that are used inside.
```swift
let query = Query(request: Request(
withAlias: "test",
name: "content",
arguments: [
Argument(key: "id", values: [153082687])
],
fields: [
articleContent
]),
fragments: [articleContent, imageContent]
)
```
All we have to do now is to call `create()` on our Query and we're good to go.
```
print(query.create())
```
### Mutation
Let's assume, we want to change our username and our age in our backend and we want to have the new name and age back to make sure everything went right.
Let's assume further, our server provides a mutating method `editMe` for exactly that purpose.
Our graphQL query for that will look like this:
```graphQL
mutation myMutation {
editMe(
name: "joe",
age: 99
)
{
name,
age
}
}
```
Let us first create the actual mutating function. We can use a `Request` for that. As `Argument` `values` we give information about which fields should be changed and what's the actual change
```swift
let mutatingRequest = Request(
name: "editMe",
arguments: [
Argument(name: "name", value: "joe"),
Argument(name: "age", value: 99)
],
fields: [
"name",
"age"
]
)
```
Finally, we put everything together as a `Mutation`.
`Mutation`s work just like `Queries`
```swift
let mutation = Mutation(
withAlias: "myMutation",
mutatingRequest: mutatingRequest
)
```
After we've done that we can create the request.
```swift
print(mutation.create())
```
## Breaking changes
### From `0.7` to `0.8`
- `ReadingRequest` is now simply `Request`
- `MutatingRequest` has been removed, you can use `Request` instead
- `MutatingArgument` has been removed, you can use `Argument` instead
- `MutatingValue` and `MutatingField` have been removed, you can use `Argument`, or `ObjectValue` and `ObjectKeyValuePair` instead
## Authors
`GraphQLicious` was made in-house by WeltN24
### Contributors
Felix Dietz, [[email protected]](mailto:[email protected]), [@podboq](https://github.com/podboq) ([@joemcbomb](https://github.com/joemcbomb)) on Github, [@joemcbomb](https://twitter.com/joemcbomb) on Twitter
Vittorio Monaco, [[email protected]](mailto:[email protected]), [@vittoriom](https://github.com/vittoriom) on Github, [@Vittorio_Monaco](https://twitter.com/Vittorio_Monaco) on Twitter
## License
`GraphQLicious` is available under the MIT license. See the LICENSE files for more info.