Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jangorman/chester
Chester is a Swift GraphQL query builder.
https://github.com/jangorman/chester
dsl graphql ios swift
Last synced: 3 days ago
JSON representation
Chester is a Swift GraphQL query builder.
- Host: GitHub
- URL: https://github.com/jangorman/chester
- Owner: JanGorman
- License: mit
- Created: 2016-03-27T15:13:12.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T07:56:55.000Z (15 days ago)
- Last Synced: 2024-10-29T08:37:11.865Z (15 days ago)
- Topics: dsl, graphql, ios, swift
- Language: Swift
- Size: 315 KB
- Stars: 100
- Watchers: 5
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chester
[](https://codecov.io/github/JanGorman/Chester?branch=master)
[](https://swift.org/package-manager/)
[](https://github.com/Carthage/Carthage)
[](http://cocoapods.org/pods/Chester)
[](http://cocoapods.org/pods/Chester)
[](http://cocoapods.org/pods/Chester)
## Sort of Experimental: @resultBuilder Support
`@resultBuilder` seems like a natural match for this kind of task. There's a separate `GraphQLBuilderTests` test suite that shows the supported cases. In its basic form you can construct a query like this:
```swift
import Chester
let query = GraphQLQuery {
From("posts")
Fields("id", "title")
}
```
Nested queries can be defined in their logical order now:
```swift
let query = GraphQLQuery {
From("posts")
Fields("id", "title")
SubQuery {
From("comments")
Fields("body")
SubQuery {
From("author")
Fields("firstname")
}
}
}
```
### Known Issues
- Queries with multiple root fields and arguments produce a compiler error (e.g. `'Int' is not convertible to 'Any'`)
## Usage
Chester uses the builder pattern to construct GraphQL queries. In its basic form use it like this:
```swift
import Chester
let query = QueryBuilder()
.from("posts")
.with(arguments: Argument(key: "id", value: "20"), Argument(key: "author", value: "Chester"))
.with(fields: "id", "title", "content")
// For cases with dynamic input, probably best to use a do-catch:
do {
let queryString = try query.build
} catch {
// Can specify which errors to catch
}
// Or if you're sure of your query
guard let queryString = try? query.build else { return }
```
You can add subqueries. Add as many as needed. You can nest them as well.
```swift
let commentsQuery = QueryBuilder()
.from("comments")
.with(fields: "id", content)
let postsQuery = QueryBuilder()
.from("posts")
.with(fields: "id", "title")
.with(subQuery: commentsQuery)
```
You can search on multiple collections at once
```swift
let search = QueryBuilder()
.from("search")
.with(arguments: Argument(key: "text", value: "an"))
.on("Human", "Droid")
.with(fields: "name")
.build()
```
Check the included unit tests for further examples.
## Requirements
- Swift 5
- Xcode 12.5+
- iOS 8
## Installation
Chester is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod "Chester"
```
Or [Carthage](https://github.com/Carthage/Carthage). Add Chester to your Cartfile:
```ogdl
github "JanGorman/Chester"
```
Or [Swift Package Manager](https://swift.org/package-manager/). To install it,
simply go to File > Swift Package > Add Swift Package Dependency and add "https://github.com/JanGorman/Chester.git" as Swift Package URL.
Or add the following line to Package.swift:
```swift
dependencies: [
.package(url: "https://github.com/JanGorman/Chester.git", from: "0.14.0")
]
```
## Author
[Jan Gorman](https://twitter.com/JanGorman)
## License
Chester is available under the MIT license. See the LICENSE file for more info.