mirror of
https://github.com/stashapp/stash.git
synced 2025-12-22 00:06:29 +01:00
7a45943e8e
* Add gql client generation files * Update dependencies * Add stash-box client generation to the makefile * Move scraped scene object matchers to models * Add stash-box to scrape with dropdown * Add scrape scene from fingerprint in UI
113 lines
4.5 KiB
Markdown
113 lines
4.5 KiB
Markdown
# gqlgen [](https://github.com/99designs/gqlgen/actions) [](http://gqlgen.com/) [](https://godoc.org/github.com/99designs/gqlgen)
|
|
|
|
|
|
|
|
## What is gqlgen?
|
|
|
|
[gqlgen](https://github.com/99designs/gqlgen) is a Go library for building GraphQL servers without any fuss.<br/>
|
|
|
|
- **gqlgen is based on a Schema first approach** — You get to Define your API using the GraphQL [Schema Definition Language](http://graphql.org/learn/schema/).
|
|
- **gqlgen priortizes Type safety** — You should never see `map[string]interface{}` here.
|
|
- **gqlgen enables Codegen** — We generate the boring bits, so you can focus on building your app quickly.
|
|
|
|
Still not convinced enough to use **gqlgen**? Compare **gqlgen** with other Go graphql [implementations](https://gqlgen.com/feature-comparison/)
|
|
|
|
## Getting Started
|
|
- To install gqlgen run the comand `go get github.com/99designs/gqlgen` in your project directory.<br/>
|
|
- You could initialize a new project using the recommended folder structure by running this command `go run github.com/99designs/gqlgen init`.
|
|
|
|
You could find a more comprehensive guide to help you get started [here](https://gqlgen.com/getting-started/).<br/>
|
|
We also have a couple of real-world [examples](https://github.com/99designs/gqlgen/tree/master/example) that show how to GraphQL applicatons with **gqlgen** seamlessly,
|
|
You can see these [examples](https://github.com/99designs/gqlgen/tree/master/example) here or visit [godoc](https://godoc.org/github.com/99designs/gqlgen).
|
|
|
|
## Reporting Issues
|
|
|
|
If you think you've found a bug, or something isn't behaving the way you think it should, please raise an [issue](https://github.com/99designs/gqlgen/issues) on GitHub.
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions, Read our [Contribution Guidelines](https://github.com/99designs/gqlgen/blob/master/CONTRIBUTING.md) to learn more about contributing to **gqlgen**
|
|
## Frequently asked questions
|
|
|
|
### How do I prevent fetching child objects that might not be used?
|
|
|
|
When you have nested or recursive schema like this:
|
|
|
|
```graphql
|
|
type User {
|
|
id: ID!
|
|
name: String!
|
|
friends: [User!]!
|
|
}
|
|
```
|
|
|
|
You need to tell gqlgen that it should only fetch friends if the user requested it. There are two ways to do this;
|
|
|
|
- #### Using Custom Models
|
|
|
|
Write a custom model that omits the friends field:
|
|
|
|
```go
|
|
type User struct {
|
|
ID int
|
|
Name string
|
|
}
|
|
```
|
|
|
|
And reference the model in `gqlgen.yml`:
|
|
|
|
```yaml
|
|
# gqlgen.yml
|
|
models:
|
|
User:
|
|
model: github.com/you/pkg/model.User # go import path to the User struct above
|
|
```
|
|
|
|
- #### Using Explicit Resolvers
|
|
|
|
If you want to Keep using the generated model, mark the field as requiring a resolver explicitly in `gqlgen.yml` like this:
|
|
|
|
```yaml
|
|
# gqlgen.yml
|
|
models:
|
|
User:
|
|
fields:
|
|
friends:
|
|
resolver: true # force a resolver to be generated
|
|
```
|
|
|
|
After doing either of the above and running generate we will need to provide a resolver for friends:
|
|
|
|
```go
|
|
func (r *userResolver) Friends(ctx context.Context, obj *User) ([]*User, error) {
|
|
// select * from user where friendid = obj.ID
|
|
return friends, nil
|
|
}
|
|
```
|
|
|
|
### Can I change the type of the ID from type String to Type Int?
|
|
|
|
Yes! You can by remapping it in config as seen below:
|
|
|
|
```yaml
|
|
models:
|
|
ID: # The GraphQL type ID is backed by
|
|
model:
|
|
- github.com/99designs/gqlgen/graphql.IntID # An go integer
|
|
- github.com/99designs/gqlgen/graphql.ID # or a go string
|
|
```
|
|
|
|
This means gqlgen will be able to automatically bind to strings or ints for models you have written yourself, but the
|
|
first model in this list is used as the default type and it will always be used when:
|
|
|
|
- Generating models based on schema
|
|
- As arguments in resolvers
|
|
|
|
There isnt any way around this, gqlgen has no way to know what you want in a given context.
|
|
|
|
## Other Resources
|
|
|
|
- [Christopher Biscardi @ Gophercon UK 2018](https://youtu.be/FdURVezcdcw)
|
|
- [Introducing gqlgen: a GraphQL Server Generator for Go](https://99designs.com.au/blog/engineering/gqlgen-a-graphql-server-generator-for-go/)
|
|
- [Dive into GraphQL by Iván Corrales Solera](https://medium.com/@ivan.corrales.solera/dive-into-graphql-9bfedf22e1a)
|
|
- [Sample Project built on gqlgen with Postgres by Oleg Shalygin](https://github.com/oshalygin/gqlgen-pg-todo-example)
|